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

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
doc/classes/EditorImportPlugin.xml
View File

@@ -114,35 +114,28 @@
</tutorials>
<methods>
<method name="_get_import_options" qualifiers="virtual">
<return type="Array">
</return>
<argument index="0" name="preset" type="int">
</argument>
<return type="Array" />
<argument index="0" name="preset" type="int" />
<description>
Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional).
</description>
</method>
<method name="_get_import_order" qualifiers="virtual">
<return type="int">
</return>
<return type="int" />
<description>
Gets the order of this importer to be run when importing resources. Importers with [i]lower[/i] import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is [code]0[/code] unless overridden by a specific importer. See [enum ResourceImporter.ImportOrder] for some predefined values.
</description>
</method>
<method name="_get_importer_name" qualifiers="virtual">
<return type="String">
</return>
<return type="String" />
<description>
Gets the unique name of the importer.
</description>
</method>
<method name="_get_option_visibility" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="option" type="String">
</argument>
<argument index="1" name="options" type="Dictionary">
</argument>
<return type="bool" />
<argument index="0" name="option" type="String" />
<argument index="1" name="options" type="Dictionary" />
<description>
This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example:
[codeblocks]
@@ -171,69 +164,55 @@
</description>
</method>
<method name="_get_preset_count" qualifiers="virtual">
<return type="int">
</return>
<return type="int" />
<description>
Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset.
</description>
</method>
<method name="_get_preset_name" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="preset" type="int">
</argument>
<return type="String" />
<argument index="0" name="preset" type="int" />
<description>
Gets the name of the options preset at this index.
</description>
</method>
<method name="_get_priority" qualifiers="virtual">
<return type="float">
</return>
<return type="float" />
<description>
Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code].
</description>
</method>
<method name="_get_recognized_extensions" qualifiers="virtual">
<return type="Array">
</return>
<return type="Array" />
<description>
Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code].
</description>
</method>
<method name="_get_resource_type" qualifiers="virtual">
<return type="String">
</return>
<return type="String" />
<description>
Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code].
</description>
</method>
<method name="_get_save_extension" qualifiers="virtual">
<return type="String">
</return>
<return type="String" />
<description>
Gets the extension used to save this resource in the [code].godot/imported[/code] directory.
</description>
</method>
<method name="_get_visible_name" qualifiers="virtual">
<return type="String">
</return>
<return type="String" />
<description>
Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh".
</description>
</method>
<method name="_import" qualifiers="virtual">
<return type="int">
</return>
<argument index="0" name="source_file" type="String">
</argument>
<argument index="1" name="save_path" type="String">
</argument>
<argument index="2" name="options" type="Dictionary">
</argument>
<argument index="3" name="platform_variants" type="Array">
</argument>
<argument index="4" name="gen_files" type="Array">
</argument>
<return type="int" />
<argument index="0" name="source_file" type="String" />
<argument index="1" name="save_path" type="String" />
<argument index="2" name="options" type="Dictionary" />
<argument index="3" name="platform_variants" type="Array" />
<argument index="4" name="gen_files" type="Array" />
<description>
Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function.
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.