diff options
Diffstat (limited to 'doc/classes/StringName.xml')
| -rw-r--r-- | doc/classes/StringName.xml | 67 |
1 files changed, 56 insertions, 11 deletions
diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 5d8ac6fdcc..b32665a09f 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -4,21 +4,66 @@ An optimized string type for unique names. </brief_description> <description> - [StringName]s are immutable strings designed for general-purpose represention 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. + [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. </description> <tutorials> </tutorials> - <methods> - <method name="StringName"> - <return type="StringName"> - </return> - <argument index="0" name="from" type="String"> - </argument> + <constructors> + <constructor name="StringName"> + <return type="StringName" /> + <description> + Constructs an empty [StringName]. + </description> + </constructor> + <constructor name="StringName"> + <return type="StringName" /> + <argument index="0" name="from" type="StringName" /> + <description> + Constructs a [StringName] as a copy of the given [StringName]. + </description> + </constructor> + <constructor name="StringName"> + <return type="StringName" /> + <argument index="0" name="from" type="String" /> <description> Creates a new [StringName] from the given [String]. </description> - </method> - </methods> - <constants> - </constants> + </constructor> + </constructors> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + </operators> </class> |