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

84
doc/classes/EditorFeatureProfile.xml
View File

@@ -11,112 +11,84 @@
</tutorials>
<methods>
<method name="get_feature_name">
<return type="String">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<return type="String" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<description>
Returns the specified [code]feature[/code]'s human-readable name.
</description>
</method>
<method name="is_class_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<return type="bool" />
<argument index="0" name="class_name" type="StringName" />
<description>
Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog.
</description>
</method>
<method name="is_class_editor_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<return type="bool" />
<argument index="0" name="class_name" type="StringName" />
<description>
Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.
</description>
</method>
<method name="is_class_property_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="property" type="StringName">
</argument>
<return type="bool" />
<argument index="0" name="class_name" type="StringName" />
<argument index="1" name="property" type="StringName" />
<description>
Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].
</description>
</method>
<method name="is_feature_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<return type="bool" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<description>
Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely.
</description>
</method>
<method name="load_from_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<description>
Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method.
</description>
</method>
<method name="save_to_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<description>
Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] button.
</description>
</method>
<method name="set_disable_class">
<return type="void">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<return type="void" />
<argument index="0" name="class_name" type="StringName" />
<argument index="1" name="disable" type="bool" />
<description>
If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog.
</description>
</method>
<method name="set_disable_class_editor">
<return type="void">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<return type="void" />
<argument index="0" name="class_name" type="StringName" />
<argument index="1" name="disable" type="bool" />
<description>
If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.
</description>
</method>
<method name="set_disable_class_property">
<return type="void">
</return>
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="disable" type="bool">
</argument>
<return type="void" />
<argument index="0" name="class_name" type="StringName" />
<argument index="1" name="property" type="StringName" />
<argument index="2" name="disable" type="bool" />
<description>
If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].
</description>
</method>
<method name="set_disable_feature">
<return type="void">
</return>
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<return type="void" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<argument index="1" name="disable" type="bool" />
<description>
If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely.
</description>