36 lines
1.0 KiB
XML
36 lines
1.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Reference" inherits="Object" category="Core" version="3.1">
|
|
<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>
|
|
<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>
|