Added the function and macro group pages for Doxygen.

[wxWidgets.git] / interface / html / htmltag.h

diff --git a/interface/html/htmltag.h b/interface/html/htmltag.h
index a54ef932d1cbdb48828308d35505ff889072cece..6a6ef9606ec34e82cfa743b8412c07775ba5d47d 100644 (file)
--- a/interface/html/htmltag.h
+++ b/interface/html/htmltag.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmltag.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmltag.h

-// Purpose:     documentation for wxHtmlTag class
+// Purpose:     interface of wxHtmlTag

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -33,35 +33,35 @@ public:
         Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
         tag.GetAllParams() would return @c SIZE=+2 COLOR="#000000".
     */
         Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
         tag.GetAllParams() would return @c SIZE=+2 COLOR="#000000".
     */

-    const wxString GetAllParams();
+    const wxString GetAllParams() const;

 
     /**
         Returns beginning position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */
 
     /**
         Returns beginning position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */

-    int GetBeginPos();
+    int GetBeginPos() const;

 
     /**
         Returns ending position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */
 
     /**
         Returns ending position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */

-    int GetEndPos1();
+    int GetEndPos1() const;

 
     /**
         Returns ending position 2 of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */
 
     /**
         Returns ending position 2 of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
     */

-    int GetEndPos2();
+    int GetEndPos2() const;

 
     /**
         Returns tag's name. The name is always in uppercase and it doesn't contain
         '' or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT"
         and name of @c /table is "TABLE")
     */
 
     /**
         Returns tag's name. The name is always in uppercase and it doesn't contain
         '' or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT"
         and name of @c /table is "TABLE")
     */

-    wxString GetName();
+    wxString GetName() const;

 
     /**
         Returns the value of the parameter. You should check whether the
 
     /**
         Returns the value of the parameter. You should check whether the


@@ -72,7 +72,7 @@ public:
         @param with_quotes
             @true if you want to get quotes as well. See example.
     */
         @param with_quotes
             @true if you want to get quotes as well. See example.
     */

-    wxString GetParam(const wxString& par, bool with_quotes = false);
+    wxString GetParam(const wxString& par, bool with_quotes = false) const;

 
     /**
         Interprets tag parameter @a par as colour specification and saves its value
 
     /**
         Interprets tag parameter @a par as colour specification and saves its value


@@ -80,7 +80,7 @@ public:
         Returns @true on success and @false if @a par is not colour specification or
         if the tag has no such parameter.
     */
         Returns @true on success and @false if @a par is not colour specification or
         if the tag has no such parameter.
     */

-    bool GetParamAsColour(const wxString& par, wxColour* clr);
+    bool GetParamAsColour(const wxString& par, wxColour* clr) const;

 
     /**
         Interprets tag parameter @a par as an integer and saves its value
 
     /**
         Interprets tag parameter @a par as an integer and saves its value


@@ -88,7 +88,7 @@ public:
         Returns @true on success and @false if @a par is not an integer or
         if the tag has no such parameter.
     */
         Returns @true on success and @false if @a par is not an integer or
         if the tag has no such parameter.
     */

-    bool GetParamAsInt(const wxString& par, int* value);
+    bool GetParamAsInt(const wxString& par, int* value) const;

 
     /**
         Returns @true if this tag is paired with ending tag, @false otherwise.
 
     /**
         Returns @true if this tag is paired with ending tag, @false otherwise.


@@ -98,7 +98,7 @@ public:
         doesn't have ending tag while the second P has. The third P tag (which
         is ending itself) of course doesn't have ending tag.
     */
         doesn't have ending tag while the second P has. The third P tag (which
         is ending itself) of course doesn't have ending tag.
     */

-    bool HasEnding();
+    bool HasEnding() const;

 
     /**
         Returns @true if the tag has a parameter of the given name.
 
     /**
         Returns @true if the tag has a parameter of the given name.


@@ -108,7 +108,7 @@ public:
         @param par
             the parameter you're looking for.
     */
         @param par
             the parameter you're looking for.
     */

-    bool HasParam(const wxString& par);
+    bool HasParam(const wxString& par) const;

 
     /**
         This method scans the given parameter. Usage is exactly the same as sscanf's
 
     /**
         This method scans the given parameter. Usage is exactly the same as sscanf's


@@ -125,5 +125,6 @@ public:
             pointer to a variable to store the value in
     */
     wxString ScanParam(const wxString& par, const wxChar* format,
             pointer to a variable to store the value in
     */
     wxString ScanParam(const wxString& par, const wxChar* format,

-                       void* value);
+                       void* value) const;

 };
 };

+