Another doc patch from Tim

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h
index 6e4cf6fb35c359228184b288b08966132546aef7..66a452945c17b09f8ab1651c266624cb199b377d 100644 (file)
--- a/interface/wx/html/htmltag.h
+++ b/interface/wx/html/htmltag.h
@@ -101,7 +101,7 @@ 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

diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 88c8d955ada752dc5fad6bf2c00f96c0d4fb5949..686ecaf4d4e6bf2a40017e17d65f0f8ca97d0746 100644 (file)
--- a/interface/wx/stattext.h
+++ b/interface/wx/stattext.h
@@ -117,77 +117,81 @@ public:
         support it (currently only GTK+ 2). For the other platforms, the markup is
         ignored.
         The supported tags are:
-
-        b
-
-        bold text
-
-        big
-
-        bigger text
-
-        i
-
-        italic text
-
-        s
-
-        strike-through text
-
-        sub
-
-        subscript text
-
-        sup
-
-        superscript text
-
-        small
-
-        smaller text
-
-        tt
-
-        monospaced text
-
-        u
-
-        underlined text
-
-        span
-
-        generic formatter tag; see Pango Markup for more information.
+        <TABLE>
+            <TR>
+                <TD>&lt;b&gt;</TD>
+                <TD>bold text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;big&gt;</TD>
+                <TD>bigger text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;i&gt;</TD>
+                <TD>italic text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;s&gt;</TD>
+                <TD>strike-through text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;sub&gt;</TD>
+                <TD>subscript text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;sup&gt;</TD>
+                <TD>superscript text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;small&gt;</TD>
+                <TD>smaller text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;tt&gt;</TD>
+                <TD>monospaced text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;u&gt;</TD>
+                <TD>underlined text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;span&gt;</TD>
+                <TD>generic formatter tag; see Pango Markup for more information.</TD>
+            </TR>
+        </TABLE>
 
         Note that the string must be well-formed (e.g. all tags must be correctly
         closed)
         otherwise it can be not shown correctly or at all.
         Also note that you need to escape the following special characters:
-
-        @b Special character
-
-        @b Escape as
-
-        @c
-
-        @c amp; or as @c
-
-        @c '
-
-        @c apos;
-
-        @c "
-
-        @c quot;
-
-        @c
-
-        @c lt;
-
-        @c
-
-        @c gt;
-
-        The non-escaped ampersand @c  characters are interpreted as
+        <TABLE>
+            <TR>
+                <TD>@b Special character</TD>
+                <TD>@b Escape as</TD>
+            </TR>
+            <TR>
+                <TD>@c &amp;</TD>
+                <TD>@c &amp;amp; or as &amp;&amp;</TD>
+            </TR>
+            <TR>
+                <TD>@c &apos;</TD>
+                <TD>@c &amp;apos;</TD>
+            </TR>
+            <TR>
+                <TD>@c &quot;</TD>
+                <TD>@c &amp;quot;</TD>
+            </TR>
+            <TR>
+                <TD>@c &lt;</TD>
+                <TD>@c &amp;lt;</TD>
+            </TR>
+            <TR>
+                <TD>@c &gt;</TD>
+                <TD>@c &amp;gt;</TD>
+            </TR>
+        </TABLE>
+        
+        The non-escaped ampersand @c &amp; characters are interpreted as
         mnemonics; see wxControl::SetLabel.
 
         Example:

diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h
index ef8eb21e9c421118dfb41dd24f1a2d5682c10079..3f2ea0b84ae3388ec5df98fc9df0e8d56159499c 100644 (file)
--- a/interface/wx/stc/stc.h
+++ b/interface/wx/stc/stc.h
@@ -2544,8 +2544,8 @@ public:
         more of the following comma separated elements:
         bold                    turns on bold
         italic                  turns on italics
-        fore:[name or #RRGGBB]  sets the foreground colour
-        back:[name or #RRGGBB]  sets the background colour
+        fore:[name or \#RRGGBB]  sets the foreground colour
+        back:[name or \#RRGGBB]  sets the background colour
         face:[facename]         sets the font face name to use
         size:[num]              sets the font size in points
         eol                     turns on eol filling

diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h
index f8516d0ce518feb53c200fc72cefe124876115da..24cd67f0263a79614db25556d115181ad9a1c848 100644 (file)
--- a/interface/wx/stdpaths.h
+++ b/interface/wx/stdpaths.h
@@ -180,7 +180,7 @@ public:
     /**
         Return the directory for the user-dependent application data files:
              - Unix: @c ~/.appname
-             - Windows: @c C:\\Documents @c and @c Settings\\username\Application @c Data\\appname
+             - Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\appname
              - Mac: @c ~/Library/Application @c Support/appname
     */
     wxString GetUserDataDir() const;

diff --git a/interface/wx/xrc/xmlres.h b/interface/wx/xrc/xmlres.h
index a74ba85f4566181025418d9a13e0c79f4e2b2885..6179eb4b01434aba1d421fcac60d74a5a9a49670 100644 (file)
--- a/interface/wx/xrc/xmlres.h
+++ b/interface/wx/xrc/xmlres.h
@@ -324,7 +324,7 @@ public:
     bool GetBool(const wxString& param, bool defaultv = false);
 
     /**
-        Gets colour in HTML syntax (#RRGGBB).
+        Gets colour in HTML syntax (\#RRGGBB).
     */
     wxColour GetColour(const wxString& param,
                    const wxColour& default = wxNullColour);