diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-03-13 17:02:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-13 17:02:07 +0100 |
| commit | 0ed8d05314c9c1deeb6f45da3960b31aef7deed7 (patch) | |
| tree | 1bf685c73ef05b90b3342869dae1785f72aa9cd5 /doc/classes/StringName.xml | |
| parent | 88dd5d374fd4f9653b37b93a08df6ddac035f0ea (diff) | |
| parent | e103f21a40ef157cd263b60cf0d9c5750156ec98 (diff) | |
| download | redot-engine-0ed8d05314c9c1deeb6f45da3960b31aef7deed7.tar.gz | |
Merge pull request #36773 from KoBeWi/thats_a_lotta_docs
Add LOTS of missing docs
Diffstat (limited to 'doc/classes/StringName.xml')
| -rw-r--r-- | doc/classes/StringName.xml | 3 |
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> |