From: Robert Roebling Date: Fri, 29 Aug 2008 12:15:59 +0000 (+0000) Subject: Another doc patch from Tim X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/3f5506cfd36dce2b97c016be6ab8d4f60b195058?hp=e85eaef3fa3238c3bb387f17b1f00217b1d4c278 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 6e4cf6fb35..66a452945c 100644 --- 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 88c8d955ad..686ecaf4d4 100644 --- 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
<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.
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 + + + + + + + + + + + + + + + + + + + + + + + + + +
@b Special character@b Escape as
@c &@c &amp; or as &&
@c '@c &apos;
@c "@c &quot;
@c <@c &lt;
@c >@c &gt;
+ + The non-escaped ampersand @c & characters are interpreted as mnemonics; see wxControl::SetLabel. Example: diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h index ef8eb21e9c..3f2ea0b84a 100644 --- 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 f8516d0ce5..24cd67f026 100644 --- 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 a74ba85f45..6179eb4b01 100644 --- 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);