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

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/EditorInspectorPlugin.xml
View File

@@ -16,83 +16,62 @@
</tutorials>
<methods>
<method name="_can_handle" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="object" type="Object">
</argument>
<return type="bool" />
<argument index="0" name="object" type="Object" />
<description>
Returns [code]true[/code] if this object can be handled by this plugin.
</description>
</method>
<method name="_parse_begin" qualifiers="virtual">
<return type="void">
</return>
<return type="void" />
<description>
Called to allow adding controls at the beginning of the list.
</description>
</method>
<method name="_parse_category" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="category" type="String">
</argument>
<return type="void" />
<argument index="0" name="category" type="String" />
<description>
Called to allow adding controls at the beginning of the category.
</description>
</method>
<method name="_parse_end" qualifiers="virtual">
<return type="void">
</return>
<return type="void" />
<description>
Called to allow adding controls at the end of the list.
</description>
</method>
<method name="_parse_property" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="type" type="int">
</argument>
<argument index="1" name="path" type="String">
</argument>
<argument index="2" name="hint" type="int">
</argument>
<argument index="3" name="hint_text" type="String">
</argument>
<argument index="4" name="usage" type="int">
</argument>
<return type="bool" />
<argument index="0" name="type" type="int" />
<argument index="1" name="path" type="String" />
<argument index="2" name="hint" type="int" />
<argument index="3" name="hint_text" type="String" />
<argument index="4" name="usage" type="int" />
<description>
Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.
</description>
</method>
<method name="add_custom_control">
<return type="void">
</return>
<argument index="0" name="control" type="Control">
</argument>
<return type="void" />
<argument index="0" name="control" type="Control" />
<description>
Adds a custom control, not necessarily a property editor.
</description>
</method>
<method name="add_property_editor">
<return type="void">
</return>
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="editor" type="Control">
</argument>
<return type="void" />
<argument index="0" name="property" type="String" />
<argument index="1" name="editor" type="Control" />
<description>
Adds a property editor, this must inherit [EditorProperty].
</description>
</method>
<method name="add_property_editor_for_multiple_properties">
<return type="void">
</return>
<argument index="0" name="label" type="String">
</argument>
<argument index="1" name="properties" type="PackedStringArray">
</argument>
<argument index="2" name="editor" type="Control">
</argument>
<return type="void" />
<argument index="0" name="label" type="String" />
<argument index="1" name="properties" type="PackedStringArray" />
<argument index="2" name="editor" type="Control" />
<description>
Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty].
</description>