summaryrefslogtreecommitdiffstats
path: root/doc/classes/WeakRef.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2021-01-04 14:33:44 +0100
committerRémi Verschelde <rverschelde@gmail.com>2021-01-04 14:33:44 +0100
commit215d18814e3db5371ed7aae9555ac25bf7d1a00e (patch)
treefe36a04fbf8486e1d59b87d0525dea57659f3e1e /doc/classes/WeakRef.xml
parent8bfd96ee3f499035773b750f31e875cd3ef3b1fb (diff)
downloadredot-engine-215d18814e3db5371ed7aae9555ac25bf7d1a00e.tar.gz
doc: Sync classref with current source
Diffstat (limited to 'doc/classes/WeakRef.xml')
-rw-r--r--doc/classes/WeakRef.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml
index 07d82289a3..4140df5828 100644
--- a/doc/classes/WeakRef.xml
+++ b/doc/classes/WeakRef.xml
@@ -4,7 +4,7 @@
Holds an [Object], but does not contribute to the reference count if the object is a reference.
</brief_description>
<description>
- A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
+ A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
</description>
<tutorials>
</tutorials>