godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +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.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent c5589c76ce
commit 16fd1c421e
350 changed files with 10551 additions and 21102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
doc/classes/Script.xml
View File

@@ -12,100 +12,83 @@
</tutorials>
<methods>
<method name="can_instance" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if the script can be instanced.
</description>
</method>
<method name="get_base_script" qualifiers="const">
<return type="Script">
</return>
<return type="Script" />
<description>
Returns the script directly inherited by this script.
</description>
</method>
<method name="get_instance_base_type" qualifiers="const">
<return type="String">
</return>
<return type="String" />
<description>
Returns the script's base type.
</description>
</method>
<method name="get_property_default_value">
<return type="Variant">
</return>
<argument index="0" name="property" type="String">
</argument>
<return type="Variant" />
<argument index="0" name="property" type="String" />
<description>
Returns the default value of the specified property.
</description>
</method>
<method name="get_script_constant_map">
<return type="Dictionary">
</return>
<return type="Dictionary" />
<description>
Returns a dictionary containing constant names and their values.
</description>
</method>
<method name="get_script_method_list">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns the list of methods in this [Script].
</description>
</method>
<method name="get_script_property_list">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns the list of properties in this [Script].
</description>
</method>
<method name="get_script_signal_list">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns the list of user signals defined in this [Script].
</description>
</method>
<method name="has_script_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="signal_name" type="String">
</argument>
<return type="bool" />
<argument index="0" name="signal_name" type="String" />
<description>
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
</description>
</method>
<method name="has_source_code" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if the script contains non-empty source code.
</description>
</method>
<method name="instance_has" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="base_object" type="Object">
</argument>
<return type="bool" />
<argument index="0" name="base_object" type="Object" />
<description>
Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.
</description>
</method>
<method name="is_tool" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.
</description>
</method>
<method name="reload">
<return type="int" enum="Error">
</return>
<argument index="0" name="keep_state" type="bool" default="false">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="keep_state" type="bool" default="false" />
<description>
Reloads the script's class implementation. Returns an error code.
</description>