]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/richtext/richtextxml.h
Minor doc improvements
[wxWidgets.git] / interface / richtext / richtextxml.h
index 8f19093f70b707beb792fbfa580d343ccddbc70b..f469e5401ab0cbc17c3a1ed2f9ed3b2e66f608d5 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        richtext/richtextxml.h
-// Purpose:     documentation for wxRichTextXMLHandler class
+// Purpose:     interface of wxRichTextXMLHandler
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     functions directly.
 
     @library{wxrichtext}
-    @category{FIXME}
+    @category{richtext}
 */
 class wxRichTextXMLHandler : public wxRichTextFileHandler
 {
 public:
     /**
-        , @b const wxString&@e ext = wxT("xml"), @b int@e type = wxRICHTEXT_TYPE_XML)
-        
+        ,  wxString&@e ext = wxT("xml"), @b int@e type = wxRICHTEXT_TYPE_XML)
         Constructor.
     */
-    wxRichTextXMLHandler();
+    wxRichTextXMLHandler() const;
 
     /**
         Returns @true.
     */
-    bool CanLoad();
+    bool CanLoad() const;
 
     /**
         Returns @true.
     */
-    bool CanSave();
+    bool CanSave() const;
 
     /**
         Creates XML code for a given character or paragraph style.
     */
-    wxString CreateStyle(const wxTextAttr& attr, bool isPara = @false);
+    wxString CreateStyle(const wxTextAttr& attr, bool isPara = false);
 
     /**
         Loads buffer context from the given stream.
@@ -81,14 +80,14 @@ public:
         Helper function: gets style parameters from the given XML node.
     */
     bool GetStyle(wxTextAttr& attr, wxXmlNode* node,
-                  bool isPara = @false);
+                  bool isPara = false);
 
     /**
         Helper function: gets text from the node.
     */
     wxString GetText(wxXmlNode* node,
                      const wxString& param = wxEmptyString,
-                     bool translate = @false);
+                     bool translate = false);
 
     /**
         Helper function: returns @true if the node has the given parameter.
@@ -100,3 +99,4 @@ public:
     */
     bool ImportXML(wxRichTextBuffer* buffer, wxXmlNode* node);
 };
+