summaryrefslogtreecommitdiff
path: root/doc/classes/StringName.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/StringName.xml')
-rw-r--r--doc/classes/StringName.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml
index f323a4bb6a..5d8ac6fdcc 100644
--- a/doc/classes/StringName.xml
+++ b/doc/classes/StringName.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StringName" version="4.0">
<brief_description>
+ 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.
</description>
<tutorials>
</tutorials>
@@ -13,6 +15,7 @@
<argument index="0" name="from" type="String">
</argument>
<description>
+ Creates a new [StringName] from the given [String].
</description>
</method>
</methods>