Parcourir la source

Update description of Object.free() method

Clarify that variables pointing to an object don't become `null` when that object is freed, it just makes them invalid.

(cherry picked from commit ccf5703568ab7c33723f322088c83a7d9ebcf5a8)
Remi Rampin il y a 5 ans
Parent
commit
55bad66447
1 fichiers modifiés avec 1 ajouts et 1 suppressions
  1. 1 1
      doc/classes/Object.xml

+ 1 - 1
doc/classes/Object.xml

@@ -192,7 +192,7 @@
 			<return type="void">
 			</return>
 			<description>
-				Deletes the object from memory. Any pre-existing reference to the freed object will now return [code]null[/code].
+				Deletes the object from memory. Any pre-existing reference to the freed object will become invalid, e.g. [code]is_instance_valid(object)[/code] will return [code]false[/code].
 			</description>
 		</method>
 		<method name="get" qualifiers="const">