diff options
Diffstat (limited to 'doc/classes/Reference.xml')
| -rw-r--r-- | doc/classes/Reference.xml | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml new file mode 100644 index 0000000000..2531ea88ad --- /dev/null +++ b/doc/classes/Reference.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Reference" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for anything that keeps a reference count. + </brief_description> + <description> + Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="init_ref"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="reference"> + <return type="bool"> + </return> + <description> + Increase the internal reference counter. Use this only if you really know what you are doing. + </description> + </method> + <method name="unreference"> + <return type="bool"> + </return> + <description> + Decrease the internal reference counter. Use this only if you really know what you are doing. + </description> + </method> + </methods> + <constants> + </constants> +</class> |