fixed the anchor names for @section used in interface headers; documented the general...

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

diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h
index 974106a761f2cd8475c08ae1e646dc27aa0c31c0..0f2c67a4a3ad0feae3ab3b93e6002fc3394b51d2 100644 (file)
--- a/interface/wx/html/htmltag.h
+++ b/interface/wx/html/htmltag.h
@@ -8,26 +8,26 @@
 
 /**
     @class wxHtmlTag
-    @headerfile htmltag.h wx/html/htmltag.h
 
     This class represents a single HTML tag.
     It is used by @ref overview_handlers "tag handlers".
 
     @library{wxhtml}
-    @category{FIXME}
+    @category{html}
 */
 class wxHtmlTag
 {
-public:
+protected:
     /**
         Constructor. You will probably never have to construct a wxHtmlTag object
         yourself. Feel free to ignore the constructor parameters.
         Have a look at src/html/htmlpars.cpp if you're interested in creating it.
     */
-    wxHtmlTag(wxHtmlTag* parent, const wxString& source, int pos,
-              int end_pos, wxHtmlTagsCache* cache,
-              wxHtmlEntitiesParser* entParser);
+    wxHtmlTag(wxHtmlTag* parent, const wxString* source,
+              const const_iterator& pos, const const_iterator& end_pos,
+              wxHtmlTagsCache* cache, wxHtmlEntitiesParser* entParser);
 
+public:
     /**
         Returns a string containing all parameters.
         Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
@@ -39,6 +39,7 @@ public:
         Returns beginning position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
+        @deprecated @todo provide deprecation description
     */
     int GetBeginPos() const;
 
@@ -46,6 +47,7 @@ public:
         Returns ending position of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
+        @deprecated @todo provide deprecation description
     */
     int GetEndPos1() const;
 
@@ -53,6 +55,7 @@ public:
         Returns ending position 2 of the text @e between this tag and paired
         ending tag.
         See explanation (returned position is marked with '|'):
+        @deprecated @todo provide deprecation description
     */
     int GetEndPos2() const;
 
@@ -66,7 +69,7 @@ public:
     /**
         Returns the value of the parameter. You should check whether the
         parameter exists or not (use wxHtmlTag::HasParam) first.
-        
+
         @param par
             The parameter's name.
         @param with_quotes
@@ -93,7 +96,7 @@ public:
     /**
         Returns @true if this tag is paired with ending tag, @false otherwise.
         See the example of HTML document:
-        
+
         In this example tags HTML and BODY have ending tags, first P and BR
         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.
@@ -102,9 +105,9 @@ public:
 
     /**
         Returns @true if the tag has a parameter of the given name.
-        Example : @c FONT SIZE=+2 COLOR="#FF00FF" has two parameters named
+        Example : @c FONT SIZE=+2 COLOR="\#FF00FF" has two parameters named
         "SIZE" and "COLOR".
-        
+
         @param par
             the parameter you're looking for.
     */
@@ -116,7 +119,7 @@ public:
         argument
         and you can only retrieve one value (i.e. you can use only one "%" element
         in @e format).
-        
+
         @param par
             The name of the tag you want to query
         @param format