godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/classes/EditorExportPlugin.xml
View File

@@ -12,10 +12,10 @@
<methods>
<method name="_export_begin" qualifiers="virtual">
<return type="void" />
<argument index="0" name="features" type="PackedStringArray" />
<argument index="1" name="is_debug" type="bool" />
<argument index="2" name="path" type="String" />
<argument index="3" name="flags" type="int" />
<param index="0" name="features" type="PackedStringArray" />
<param index="1" name="is_debug" type="bool" />
<param index="2" name="path" type="String" />
<param index="3" name="flags" type="int" />
<description>
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android.
</description>
@@ -28,9 +28,9 @@
</method>
<method name="_export_file" qualifiers="virtual">
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="type" type="String" />
<argument index="2" name="features" type="PackedStringArray" />
<param index="0" name="path" type="String" />
<param index="1" name="type" type="String" />
<param index="2" name="features" type="PackedStringArray" />
<description>
Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export.
Calling [method skip] inside this callback will make the file not included in the export.
@@ -38,30 +38,30 @@
</method>
<method name="add_file">
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="file" type="PackedByteArray" />
<argument index="2" name="remap" type="bool" />
<param index="0" name="path" type="String" />
<param index="1" name="file" type="PackedByteArray" />
<param index="2" name="remap" type="bool" />
<description>
Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code].
</description>
</method>
<method name="add_ios_bundle_file">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Adds an iOS bundle file from the given [code]path[/code] to the exported project.
</description>
</method>
<method name="add_ios_cpp_code">
<return type="void" />
<argument index="0" name="code" type="String" />
<param index="0" name="code" type="String" />
<description>
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
</description>
</method>
<method name="add_ios_embedded_framework">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.
[b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code].
@@ -70,35 +70,35 @@
</method>
<method name="add_ios_framework">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.
</description>
</method>
<method name="add_ios_linker_flags">
<return type="void" />
<argument index="0" name="flags" type="String" />
<param index="0" name="flags" type="String" />
<description>
Adds linker flags for the iOS export.
</description>
</method>
<method name="add_ios_plist_content">
<return type="void" />
<argument index="0" name="plist_content" type="String" />
<param index="0" name="plist_content" type="String" />
<description>
Adds content for iOS Property List files.
</description>
</method>
<method name="add_ios_project_static_lib">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Adds a static lib from the given [code]path[/code] to the iOS project.
</description>
</method>
<method name="add_macos_plugin_file">
<return type="void" />
<argument index="0" name="path" type="String" />
<param index="0" name="path" type="String" />
<description>
Adds file or directory matching [code]path[/code] to [code]PlugIns[/code] directory of macOS app bundle.
[b]Note:[/b] This is useful only for macOS exports.
@@ -106,9 +106,9 @@
</method>
<method name="add_shared_object">
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="tags" type="PackedStringArray" />
<argument index="2" name="target" type="String" />
<param index="0" name="path" type="String" />
<param index="1" name="tags" type="PackedStringArray" />
<param index="2" name="target" type="String" />
<description>
Adds a shared object or a directory containing only shared objects with the given [code]tags[/code] and destination [code]path[/code].
[b]Note:[/b] In case of macOS exports, those shared objects will be added to [code]Frameworks[/code] directory of app bundle.