summaryrefslogtreecommitdiff
path: root/doc/classes/Callable.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:28:05 +0200
committerRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:29:52 +0200
commit7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch)
tree0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/Callable.xml
parenta1c19b9a1e53f78c75c13cb418270db80057b21a (diff)
doc: Use self-closing tags for `return` and `argument`
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.
Diffstat (limited to 'doc/classes/Callable.xml')
-rw-r--r--doc/classes/Callable.xml78
1 files changed, 26 insertions, 52 deletions
diff --git a/doc/classes/Callable.xml b/doc/classes/Callable.xml
index 3c61e8278f..5228df706b 100644
--- a/doc/classes/Callable.xml
+++ b/doc/classes/Callable.xml
@@ -37,148 +37,122 @@
</tutorials>
<methods>
<method name="Callable" qualifiers="constructor">
- <return type="Callable">
- </return>
+ <return type="Callable" />
<description>
Constructs a null [Callable] with no object nor method bound.
</description>
</method>
<method name="Callable" qualifiers="constructor">
- <return type="Callable">
- </return>
- <argument index="0" name="from" type="Callable">
- </argument>
+ <return type="Callable" />
+ <argument index="0" name="from" type="Callable" />
<description>
Constructs a [Callable] as a copy of the given [Callable].
</description>
</method>
<method name="Callable" qualifiers="constructor">
- <return type="Callable">
- </return>
- <argument index="0" name="object" type="Object">
- </argument>
- <argument index="1" name="method" type="StringName">
- </argument>
+ <return type="Callable" />
+ <argument index="0" name="object" type="Object" />
+ <argument index="1" name="method" type="StringName" />
<description>
Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code].
</description>
</method>
<method name="bind" qualifiers="vararg const">
- <return type="Callable">
- </return>
+ <return type="Callable" />
<description>
Returns a copy of this [Callable] with the arguments bound. Bound arguments are passed after the arguments supplied by [method call].
</description>
</method>
<method name="call" qualifiers="vararg const">
- <return type="Variant">
- </return>
+ <return type="Variant" />
<description>
Calls the method represented by this [Callable]. Arguments can be passed and should match the method's signature.
</description>
</method>
<method name="call_deferred" qualifiers="vararg const">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Calls the method represented by this [Callable] in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature.
</description>
</method>
<method name="get_method" qualifiers="const">
- <return type="StringName">
- </return>
+ <return type="StringName" />
<description>
Returns the name of the method represented by this [Callable].
</description>
</method>
<method name="get_object" qualifiers="const">
- <return type="Object">
- </return>
+ <return type="Object" />
<description>
Returns the object on which this [Callable] is called.
</description>
</method>
<method name="get_object_id" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the ID of this [Callable]'s object (see [method Object.get_instance_id]).
</description>
</method>
<method name="hash" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the hash value of this [Callable]'s object.
</description>
</method>
<method name="is_custom" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if this [Callable] is a custom callable whose behavior differs based on implementation details. Custom callables are used in the engine for various reasons. If [code]true[/code], you can't use [method get_method].
</description>
</method>
<method name="is_null" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if this [Callable] has no target to call the method on.
</description>
</method>
<method name="is_standard" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if this [Callable] is a standard callable, referencing an object and a method using a [StringName].
</description>
</method>
<method name="is_valid" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if the object exists and has a valid function assigned, or is a custom callable.
</description>
</method>
<method name="operator !=" qualifiers="operator">
- <return type="bool">
- </return>
- <argument index="0" name="right" type="Callable">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="right" type="Callable" />
<description>
Returns [code]true[/code] if both [Callable]s invoke different targets.
</description>
</method>
<method name="operator ==" qualifiers="operator">
- <return type="bool">
- </return>
- <argument index="0" name="right" type="Callable">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="right" type="Callable" />
<description>
Returns [code]true[/code] if both [Callable]s invoke the same custom target.
</description>
</method>
<method name="rpc" qualifiers="vararg const">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Perform an RPC (Remote Procedure Call). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error.
</description>
</method>
<method name="rpc_id" qualifiers="vararg const">
- <return type="void">
- </return>
- <argument index="0" name="peer_id" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="peer_id" type="int" />
<description>
Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error.
</description>
</method>
<method name="unbind" qualifiers="const">
- <return type="Callable">
- </return>
- <argument index="0" name="argcount" type="int">
- </argument>
+ <return type="Callable" />
+ <argument index="0" name="argcount" type="int" />
<description>
Returns a copy of this [Callable] with the arguments unbound. Calling the returned [Callable] will call the method without the extra arguments that are supplied in the [Callable] on which you are calling this method.
</description>