fix miscellaneous Doxygen 1.6.1 warnings

[wxWidgets.git] / interface / wx / stattext.h

diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 613d99661a3e7d342148ebde71dc3159cf846c95..4e297aabc5495df8ae716b278bc475f9fea1603b 100644 (file)
--- a/interface/wx/stattext.h
+++ b/interface/wx/stattext.h
@@ -89,10 +89,15 @@ public:
                 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. "<" 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><>&quot;'&</tt>) for
         wxStaticText objects with the @c wxST_MARKUP style.
-        Those symbols are replaced the corresponding entities (&lt; &gt; &quot; &apos; &amp;).
+        
+        Those symbols are replaced the corresponding entities 
+        (&amp;lt; &amp;gt; &amp;quot; &amp;apos; &amp;amp;).
     */
     static wxString EscapeMarkup(const wxString& str);