summaryrefslogtreecommitdiff
path: root/doc/classes/XMLParser.xml
diff options
context:
space:
mode:
authorAndy Maloney <asmaloney@gmail.com>2022-08-08 19:41:07 -0400
committerAndy Maloney <asmaloney@gmail.com>2022-08-09 10:09:07 -0400
commit5361585832bbdd9f047f70ea9721a17eb721317f (patch)
tree0d87da048d3e11488af3650296e4b29f895d8214 /doc/classes/XMLParser.xml
parent7355dfb502dbae6f13fbe42a9feeadb57affac0e (diff)
[doc] Use "param" instead of "code" to refer to parameters
Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
Diffstat (limited to 'doc/classes/XMLParser.xml')
-rw-r--r--doc/classes/XMLParser.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml
index ce58257817..69544f4895 100644
--- a/doc/classes/XMLParser.xml
+++ b/doc/classes/XMLParser.xml
@@ -19,14 +19,14 @@
<return type="String" />
<param index="0" name="idx" type="int" />
<description>
- Gets the name of the attribute specified by the index in [code]idx[/code] argument.
+ Gets the name of the attribute specified by the [param idx] index.
</description>
</method>
<method name="get_attribute_value" qualifiers="const">
<return type="String" />
<param index="0" name="idx" type="int" />
<description>
- Gets the value of the attribute specified by the index in [code]idx[/code] argument.
+ Gets the value of the attribute specified by the [param idx] index.
</description>
</method>
<method name="get_current_line" qualifiers="const">
@@ -39,14 +39,14 @@
<return type="String" />
<param index="0" name="name" type="String" />
<description>
- Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
+ Gets the value of a certain attribute of the current element by [param name]. This will raise an error if the element has no such attribute.
</description>
</method>
<method name="get_named_attribute_value_safe" qualifiers="const">
<return type="String" />
<param index="0" name="name" type="String" />
<description>
- Gets the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found.
+ Gets the value of a certain attribute of the current element by [param name]. This will return an empty [String] if the attribute is not found.
</description>
</method>
<method name="get_node_data" qualifiers="const">
@@ -90,14 +90,14 @@
<return type="int" enum="Error" />
<param index="0" name="file" type="String" />
<description>
- Opens an XML file for parsing. This returns an error code.
+ Opens an XML [param file] for parsing. This returns an error code.
</description>
</method>
<method name="open_buffer">
<return type="int" enum="Error" />
<param index="0" name="buffer" type="PackedByteArray" />
<description>
- Opens an XML raw buffer for parsing. This returns an error code.
+ Opens an XML raw [param buffer] for parsing. This returns an error code.
</description>
</method>
<method name="read">