mirror of https://github.com/AxioDL/tinyxml2.git
Fixed typos in code documentation.
This commit is contained in:
Thomas Ro
parent
c4ae8a9a2d
commit
08bdf50076
38
tinyxml2.h
38
tinyxml2.h
|
|
@ -225,7 +225,7 @@ private:
|
|||
|
||||
|
||||
/*
|
||||
Parent virtual class a a pool for fast allocation
|
||||
Parent virtual class of a pool for fast allocation
|
||||
and deallocation of objects.
|
||||
*/
|
||||
class MemPool
|
||||
|
|
@ -314,16 +314,16 @@ private:
|
|||
Implements the interface to the "Visitor pattern" (see the Accept() method.)
|
||||
If you call the Accept() method, it requires being passed a XMLVisitor
|
||||
class to handle callbacks. For nodes that contain other nodes (Document, Element)
|
||||
you will get called with a VisitEnter/VisitExit pair. Nodes that are always leaves
|
||||
you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs
|
||||
are simply called with Visit().
|
||||
|
||||
If you return 'true' from a Visit method, recursive parsing will continue. If you return
|
||||
false, <b>no children of this node or its sibilings</b> will be Visited.
|
||||
false, <b>no children of this node or its sibilings</b> will be visited.
|
||||
|
||||
All flavors of Visit methods have a default implementation that returns 'true' (continue
|
||||
visiting). You need to only override methods that are interesting to you.
|
||||
|
||||
Generally Accept() is called on the TiXmlDocument, although all nodes suppert Visiting.
|
||||
Generally Accept() is called on the TiXmlDocument, although all nodes support visiting.
|
||||
|
||||
You should never change the document from a callback.
|
||||
|
||||
|
|
@ -344,13 +344,13 @@ public:
|
|||
/// Visit an element.
|
||||
virtual bool VisitExit( const XMLElement& /*element*/ ) { return true; }
|
||||
|
||||
/// Visit a declaration
|
||||
/// Visit a declaration.
|
||||
virtual bool Visit( const XMLDeclaration& /*declaration*/ ) { return true; }
|
||||
/// Visit a text node
|
||||
/// Visit a text node.
|
||||
virtual bool Visit( const XMLText& /*text*/ ) { return true; }
|
||||
/// Visit a comment node
|
||||
/// Visit a comment node.
|
||||
virtual bool Visit( const XMLComment& /*comment*/ ) { return true; }
|
||||
/// Visit an unknown node
|
||||
/// Visit an unknown node.
|
||||
virtual bool Visit( const XMLUnknown& /*unknown*/ ) { return true; }
|
||||
};
|
||||
|
||||
|
|
@ -398,7 +398,7 @@ public:
|
|||
The type of a XMLNode can be queried, and it can
|
||||
be cast to its more defined type.
|
||||
|
||||
An XMLDocument allocates memory for all its Nodes.
|
||||
A XMLDocument allocates memory for all its Nodes.
|
||||
When the XMLDocument gets deleted, all its Nodes
|
||||
will also be deleted.
|
||||
|
||||
|
|
@ -443,7 +443,7 @@ public:
|
|||
|
||||
/** The meaning of 'value' changes for the specific type.
|
||||
@verbatim
|
||||
Document: empy
|
||||
Document: empty
|
||||
Element: name of the element
|
||||
Comment: the comment text
|
||||
Unknown: the tag contents
|
||||
|
|
@ -542,7 +542,7 @@ public:
|
|||
*/
|
||||
virtual bool ShallowEqual( const XMLNode* compare ) const = 0;
|
||||
|
||||
/** Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the
|
||||
/** Accept a hierarchical visit of the nodes in the TinyXML DOM. Every node in the
|
||||
XML tree will be conditionally visited and the host will be called back
|
||||
via the TiXmlVisitor interface.
|
||||
|
||||
|
|
@ -977,7 +977,7 @@ private:
|
|||
};
|
||||
|
||||
|
||||
/** A document binds together all the functionality.
|
||||
/** A Document binds together all the functionality.
|
||||
It can be saved, loaded, and printed to the screen.
|
||||
All Nodes are connected and allocated to a Document.
|
||||
If the Document is deleted, all its Nodes are also deleted.
|
||||
|
|
@ -1103,7 +1103,7 @@ public:
|
|||
XMLUnknown* NewUnknown( const char* text );
|
||||
|
||||
/**
|
||||
Delete a node associated with this documented.
|
||||
Delete a node associated with this document.
|
||||
It will be unlinked from the DOM.
|
||||
*/
|
||||
void DeleteNode( XMLNode* node ) { node->parent->DeleteChild( node ); }
|
||||
|
|
@ -1116,9 +1116,9 @@ public:
|
|||
int ErrorID() const { return errorID; }
|
||||
/// Return a possibly helpful diagnostic location or string.
|
||||
const char* GetErrorStr1() const { return errorStr1; }
|
||||
/// Return possibly helpful secondary diagnostic location or string.
|
||||
/// Return a possibly helpful secondary diagnostic location or string.
|
||||
const char* GetErrorStr2() const { return errorStr2; }
|
||||
/// If there is an error, print it to stdout
|
||||
/// If there is an error, print it to stdout.
|
||||
void PrintError() const;
|
||||
|
||||
// internal
|
||||
|
|
@ -1158,7 +1158,7 @@ private:
|
|||
<Child attributeB = "value1" />
|
||||
<Child attributeB = "value2" />
|
||||
</Element>
|
||||
<Document>
|
||||
</Document>
|
||||
@endverbatim
|
||||
|
||||
Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very
|
||||
|
|
@ -1286,7 +1286,7 @@ private:
|
|||
|
||||
It can:
|
||||
-# Print to memory.
|
||||
-# Print to a file you provide
|
||||
-# Print to a file you provide.
|
||||
-# Print XML without a XMLDocument.
|
||||
|
||||
Print to Memory
|
||||
|
|
@ -1294,7 +1294,7 @@ private:
|
|||
@verbatim
|
||||
XMLPrinter printer;
|
||||
doc->Print( &printer );
|
||||
SomeFunctior( printer.CStr() );
|
||||
SomeFunction( printer.CStr() );
|
||||
@endverbatim
|
||||
|
||||
Print to a File
|
||||
|
|
@ -1349,7 +1349,7 @@ public:
|
|||
|
||||
/// Add a text node.
|
||||
void PushText( const char* text, bool cdata=false );
|
||||
/// Add a comment
|
||||
/// Add a comment.
|
||||
void PushComment( const char* comment );
|
||||
|
||||
void PushDeclaration( const char* value );
|
||||
|
|
|
|||
Loading…
Reference in New Issue