clarify the usage of debug macros, in particular for wxFAIL (which doesn't need ...

[wxWidgets.git] / interface / wx / xml / xml.h

diff --git a/interface/wx/xml/xml.h b/interface/wx/xml/xml.h
index 794fdb882374e218e9c4aa736466544bfc0f20b0..fccaf5341f76cc0089e873fd2654e8aab9cb8530 100644 (file)
--- a/interface/wx/xml/xml.h
+++ b/interface/wx/xml/xml.h
@@ -107,18 +107,18 @@ public:
     /**
         The virtual destructor. Deletes attached children and attributes.
     */
-    ~wxXmlNode();
+    virtual ~wxXmlNode();
 
     /**
         Appends a attribute with given @a name and @a value to the list of
         attributes for this node.
     */
-    void AddAttribute(const wxString& name, const wxString& value);
+    virtual void AddAttribute(const wxString& name, const wxString& value);
 
     /**
         Appends given attribute to the list of attributes for this node.
     */
-    void AddAttribute(wxXmlAttribute* attr);
+    virtual void AddAttribute(wxXmlAttribute* attr);
 
     /**
         Adds node @a child as the last child of this node.
@@ -132,13 +132,13 @@ public:
 
         @see InsertChild(), InsertChildAfter()
     */
-    void AddChild(wxXmlNode* child);
+    virtual void AddChild(wxXmlNode* child);
 
     /**
         Removes the first attributes which has the given @a name from the list of
         attributes for this node.
     */
-    bool DeleteAttribute(const wxString& name);
+    virtual bool DeleteAttribute(const wxString& name);
 
     /**
         Returns true if a attribute named attrName could be found.
@@ -170,7 +170,7 @@ public:
         Be aware that for nodes of type @c wxXML_ELEMENT_NODE (the most used node type)
         the content is an empty string. See GetNodeContent() for more details.
     */
-    wxString GetContent() const;
+    const wxString& GetContent() const;
 
     /**
         Returns the number of nodes which separe this node from @c grandparent.
@@ -191,7 +191,7 @@ public:
         Can be an empty string (e.g. for nodes of type @c wxXML_TEXT_NODE or
         @c wxXML_CDATA_SECTION_NODE).
     */
-    wxString GetName() const;
+    const wxString& GetName() const;
 
     /**
         Returns a pointer to the sibling of this node or @NULL if there are no
@@ -254,7 +254,7 @@ public:
 
         @see AddChild(), InsertChildAfter()
     */
-    bool InsertChild(wxXmlNode* child, wxXmlNode* followingNode);
+    virtual bool InsertChild(wxXmlNode* child, wxXmlNode* followingNode);
 
     /**
         Inserts the @a child node immediately after @a precedingNode in the
@@ -263,6 +263,8 @@ public:
         @return @true if @a precedingNode has been found and the @a child
                 node has been inserted.
 
+        @param child
+            The child to insert.
         @param precedingNode
             The node to insert @a child after. As a special case, this can be
             @NULL if this node has no children yet -- in that case, @a child
@@ -272,7 +274,7 @@ public:
 
         @see InsertChild(), AddChild()
     */
-    bool InsertChildAfter(wxXmlNode* child, wxXmlNode* precedingNode);
+    virtual bool InsertChildAfter(wxXmlNode* child, wxXmlNode* precedingNode);
 
     /**
         Returns @true if the content of this node is a string containing only
@@ -292,7 +294,7 @@ public:
         Note that the caller is reponsible for deleting the removed node in order
         to avoid memory leaks.
     */
-    bool RemoveChild(wxXmlNode* child);
+    virtual bool RemoveChild(wxXmlNode* child);
 
     /**
         Sets as first attribute the given wxXmlAttribute object.
@@ -377,7 +379,7 @@ public:
     /**
         The virtual destructor.
     */
-    ~wxXmlAttribute();
+    virtual ~wxXmlAttribute();
 
     /**
         Returns the name of this attribute.
@@ -514,7 +516,7 @@ public:
     /**
         Virtual destructor. Frees the document root node.
     */
-    ~wxXmlDocument();
+    virtual ~wxXmlDocument();
 
     /**
         Detaches the document root node and returns it.
@@ -541,7 +543,7 @@ public:
         @note This is the encoding original file was saved in, @b not the
               encoding of in-memory representation!
     */
-    wxString GetFileEncoding() const;
+    const wxString& GetFileEncoding() const;
 
     /**
         Returns the root node of the document.
@@ -555,7 +557,7 @@ public:
         If the version attribute was not explicitely given in the header, this function
         returns an empty string.
     */
-    wxString GetVersion() const;
+    const wxString& GetVersion() const;
 
     /**
         Returns @true if the document has been loaded successfully.