diff options
Diffstat (limited to 'doc/classes/RID.xml')
| -rw-r--r-- | doc/classes/RID.xml | 96 |
1 files changed, 44 insertions, 52 deletions
diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index e686a4b8fd..39be605e1b 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RID" version="4.0"> +<class name="RID" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Handle for a [Resource]'s unique ID. </brief_description> @@ -8,79 +8,71 @@ </description> <tutorials> </tutorials> - <methods> - <method name="RID" qualifiers="constructor"> - <return type="RID"> - </return> + <constructors> + <constructor name="RID"> + <return type="RID" /> <description> Constructs an empty [RID] with the invalid ID [code]0[/code]. </description> - </method> - <method name="RID" qualifiers="constructor"> - <return type="RID"> - </return> - <argument index="0" name="from" type="RID"> - </argument> + </constructor> + <constructor name="RID"> + <return type="RID" /> + <argument index="0" name="from" type="RID" /> <description> Constructs a [RID] as a copy of the given [RID]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="get_id" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the ID of the referenced resource. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + <method name="is_valid" qualifiers="const"> + <return type="bool" /> <description> + Returns [code]true[/code] if [RID] is valid. </description> </method> - <method name="operator <" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool"> - </return> - <argument index="0" name="right" type="RID"> - </argument> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> <description> </description> - </method> - </methods> - <constants> - </constants> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="RID" /> + <description> + </description> + </operator> + </operators> </class> |