godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/StringName.xml

60 lines
2.0 KiB
XML
Raw Normal View History

doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StringName" version="4.0">
<brief_description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
An optimized string type for unique names.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</brief_description>
<description>
class reference proofreading
2021-03-18 11:04:28 +00:00
[StringName]s are immutable strings designed for general-purpose representation of unique names. [StringName] ensures that only one instance of a given name exists (so two [StringName]s with the same value are the same object). Comparing them is much faster than with regular [String]s, because only the pointers are compared, not the whole strings.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="StringName" qualifiers="constructor">
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.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs an empty [StringName].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="StringName" qualifiers="constructor">
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.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
<argument index="0" name="from" type="StringName" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<description>
Constructs a [StringName] as a copy of the given [StringName].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="StringName" qualifiers="constructor">
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.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
<argument index="0" name="from" type="String" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Creates a new [StringName] from the given [String].
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="operator !=" qualifiers="operator">
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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="String" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="StringName" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="String" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="StringName" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</methods>
<constants>
</constants>
</class>