mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
2fa3c65d30
godot/doc/classes/RID.xml

79 lines
2.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="RID" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Handle for a [Resource]'s unique ID.
</brief_description>
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-31 00:22:57 +08:00
The RID type is used to access the unique integer ID of a resource. They are opaque, which means they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [RenderingServer].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
<constructors>
<constructor name="RID">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="RID" />
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-10 00:46:03 +08:00
<description>
Constructs an empty [RID] with the invalid ID [code]0[/code].
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</constructor>
<constructor name="RID">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="RID" />
<argument index="0" name="from" type="RID" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-10 00:46:03 +08:00
Constructs a [RID] as a copy of the given [RID].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</constructor>
</constructors>
<methods>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="get_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[DOCS] Classref additions and corrections
2018-09-02 02:07:51 +08:00
Returns the ID of the referenced resource.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation.
2022-02-08 15:49:14 +08:00
<method name="is_valid" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if [RID] is valid.
</description>
</method>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</methods>
<operators>
<operator name="operator !=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
<operator name="operator &lt;">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
<operator name="operator &lt;=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
<operator name="operator ==">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
<operator name="operator &gt;">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
<operator name="operator &gt;=">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="right" type="RID" />
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<description>
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 10:49:02 +08:00
</operator>
</operators>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</class>
Reference in New Issue Copy Permalink