diff options
Diffstat (limited to 'doc/classes/XMLParser.xml')
| -rw-r--r-- | doc/classes/XMLParser.xml | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 55dfb5d489..6989246e24 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="XMLParser" inherits="Reference" category="Core" version="3.2"> <brief_description> - Low-level class for creating parsers for XML files. + Low-level class for creating parsers for [url=https://en.wikipedia.org/wiki/XML]XML[/url] files. </brief_description> <description> - This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. + This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low-level so it can be applied to any possible schema. </description> <tutorials> </tutorials> @@ -13,7 +13,7 @@ <return type="int"> </return> <description> - Get the amount of attributes in the current element. + Gets the amount of attributes in the current element. </description> </method> <method name="get_attribute_name" qualifiers="const"> @@ -22,7 +22,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the name of the attribute specified by the index in [code]idx[/code] argument. + Gets the name of the attribute specified by the index in [code]idx[/code] argument. </description> </method> <method name="get_attribute_value" qualifiers="const"> @@ -31,14 +31,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the value of the attribute specified by the index in [code]idx[/code] argument. + Gets the value of the attribute specified by the index in [code]idx[/code] argument. </description> </method> <method name="get_current_line" qualifiers="const"> <return type="int"> </return> <description> - Get the current line in the parsed file (currently not implemented). + Gets the current line in the parsed file (currently not implemented). </description> </method> <method name="get_named_attribute_value" qualifiers="const"> @@ -47,7 +47,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get 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 name. This will raise an error if the element has no such attribute. </description> </method> <method name="get_named_attribute_value_safe" qualifiers="const"> @@ -56,35 +56,35 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get 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 name. This will return an empty [String] if the attribute is not found. </description> </method> <method name="get_node_data" qualifiers="const"> <return type="String"> </return> <description> - Get the contents of a text node. This will raise an error in any other type of node. + Gets the contents of a text node. This will raise an error in any other type of node. </description> </method> <method name="get_node_name" qualifiers="const"> <return type="String"> </return> <description> - Get the name of the current element node. This will raise an error if the current node type is not [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END] + Gets the name of the current element node. This will raise an error if the current node type is neither [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END]. </description> </method> <method name="get_node_offset" qualifiers="const"> <return type="int"> </return> <description> - Get the byte offset of the current node since the beginning of the file or buffer. + Gets the byte offset of the current node since the beginning of the file or buffer. </description> </method> <method name="get_node_type"> <return type="int" enum="XMLParser.NodeType"> </return> <description> - Get the type of the current node. Compare with [code]NODE_*[/code] constants. + Gets the type of the current node. Compare with [code]NODE_*[/code] constants. </description> </method> <method name="has_attribute" qualifiers="const"> @@ -93,14 +93,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Check whether or not the current element has a certain attribute. + Check whether the current element has a certain attribute. </description> </method> <method name="is_empty" qualifiers="const"> <return type="bool"> </return> <description> - Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>). + Check whether the current element is empty (this only works for completely empty tags, e.g. [code]<element \>[/code]). </description> </method> <method name="open"> @@ -109,7 +109,7 @@ <argument index="0" name="file" type="String"> </argument> <description> - Open a XML file for parsing. This returns an error code. + Opens an XML file for parsing. This returns an error code. </description> </method> <method name="open_buffer"> @@ -118,14 +118,14 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> - Open a XML raw buffer for parsing. This returns an error code. + Opens an XML raw buffer for parsing. This returns an error code. </description> </method> <method name="read"> <return type="int" enum="Error"> </return> <description> - Read the next node of the file. This returns an error code. + Reads the next node of the file. This returns an error code. </description> </method> <method name="seek"> @@ -134,7 +134,7 @@ <argument index="0" name="position" type="int"> </argument> <description> - Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. + Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. </description> </method> <method name="skip_section"> |