const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxStaticTextNameStr);
+ // NB: when writing docs for the following function remember that Doxygen
+ // will always expand HTML entities (e.g. ") and thus we need to
+ // write e.g. "&lt;" to have in the output the "<" string.
/**
- Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
+ Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
wxStaticText objects with the @c wxST_MARKUP style.
- Those symbols are replaced the corresponding entities (< > " ' &).
+
+ Those symbols are replaced the corresponding entities
+ (&lt; &gt; &quot; &apos; &amp;).
*/
static wxString EscapeMarkup(const wxString& str);
<TABLE>
<TR>
- <TD>@b Special character</TD>
- <TD>@b Escape as</TD>
+ <TD><b>Special character</b></TD>
+ <TD><b>Escape as</b></TD>
</TR>
<TR>
<TD>@c &</TD>
- <TD>@c &amp; or as &&</TD>
+ <TD>@c &amp; or as @c &&</TD>
</TR>
<TR>
<TD>@c '</TD>