Fix for special characters in Doxygen comments.

Escape "-" characters in the beginning of the paragraph as they are not
handled properly by Doxygen otherwise.

Escape the space after "i.e." to prevent the brief doc string from being
terminated by it.

Escape "--" which is translated to a dash by Doxygen otherwise.

Closes #15228.

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

diff --git a/interface/wx/chartype.h b/interface/wx/chartype.h
index f67471002091e35dfb54afd660908dfbf01396b2..f22f9d1345bbebeaab3abe4ce10bfe6a5716d2b0 100644 (file)
--- a/interface/wx/chartype.h
+++ b/interface/wx/chartype.h
@@ -100,30 +100,30 @@
 
 /**
     wxChar is defined to be
-    - @c char when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- @c char when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxChar;
 
 /**
     wxSChar is defined to be
-    - <tt>signed char</tt> when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- <tt>signed char</tt> when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxSChar;
 
 /**
     wxUChar is defined to be
-    - <tt>unsigned char</tt> when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- <tt>unsigned char</tt> when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxUChar;
 
 /**
     wxStringCharType is defined to be:
-    - @c char when <tt>wxUSE_UNICODE==0</tt>
-    - @c char when <tt>wxUSE_UNICODE_WCHAR==0</tt> and <tt>wxUSE_UNICODE==1</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE_WCHAR==1</tt> and <tt>wxUSE_UNICODE==1</tt>
+    \- @c char when <tt>wxUSE_UNICODE==0</tt>
+    \- @c char when <tt>wxUSE_UNICODE_WCHAR==0</tt> and <tt>wxUSE_UNICODE==1</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE_WCHAR==1</tt> and <tt>wxUSE_UNICODE==1</tt>
 
     The @c wxUSE_UNICODE_WCHAR symbol is defined to @c 1 when building on
     Windows while it's defined to @c 0 when building on Unix, Linux or OS X.

diff --git a/interface/wx/cmdline.h b/interface/wx/cmdline.h
index 479239781c525848473acb2bc96d97d987c65e19..fdc0526c7044e3f84e50a365ab2a29bf62d05009 100644 (file)
--- a/interface/wx/cmdline.h
+++ b/interface/wx/cmdline.h
@@ -226,7 +226,7 @@ struct wxCmdLineEntryDesc
 
     First global option is the support for long (also known as GNU-style)
     options. The long options are the ones which start with two dashes and look
-    like "--verbose", i.e. they generally are complete words and not some
+    like "\--verbose", i.e. they generally are complete words and not some
     abbreviations of them. As long options are used by more and more
     applications, they are enabled by default, but may be disabled with
     DisableLongOptions().
@@ -496,7 +496,7 @@ public:
     size_t GetParamCount() const;
 
     /**
-        Parse the command line, return 0 if ok, -1 if @c "-h" or @c "--help"
+        Parse the command line, return 0 if ok, -1 if @c "-h" or @c "\--help"
         option was encountered and the help message was given or a positive
         value if a syntax error occurred.
 

diff --git a/interface/wx/richtext/richtextbuffer.h b/interface/wx/richtext/richtextbuffer.h
index 7490004cbdc4d975e8865f9e909d35842e6f6153..23e780da87371de224bf57ecfb5b750a4fb0c3e5 100644 (file)
--- a/interface/wx/richtext/richtextbuffer.h
+++ b/interface/wx/richtext/richtextbuffer.h
@@ -2110,7 +2110,7 @@ public:
     virtual bool FindPosition(wxDC& dc, wxRichTextDrawingContext& context, long index, wxPoint& pt, int* height, bool forceLineStart);
 
     /**
-        Returns the best size, i.e. the ideal starting size for this object irrespective
+        Returns the best size, i.e.\ the ideal starting size for this object irrespective
         of available space. For a short text string, it will be the size that exactly encloses
         the text. For a longer string, it might use the parent width for example.
     */
@@ -2208,7 +2208,7 @@ public:
     virtual wxString GetPropertiesMenuLabel() const { return wxEmptyString; }
 
     /**
-        Returns @true if objects of this class can accept the focus, i.e. a call to SetFocusObject
+        Returns @true if objects of this class can accept the focus, i.e.\ a call to SetFocusObject
         is possible. For example, containers supporting text, such as a text box object, can accept the focus,
         but a table can't (set the focus to individual cells instead).
     */
@@ -2503,7 +2503,7 @@ public:
     wxString GetName() const { return m_properties.GetPropertyString(wxT("name")); }
 
     /**
-        Returns @true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+        Returns @true if this object is top-level, i.e.\ contains its own paragraphs, such as a text box.
     */
     virtual bool IsTopLevel() const { return false; }
 
@@ -3578,7 +3578,7 @@ public:
     virtual bool UpdateField(wxRichTextBuffer* buffer, wxRichTextField* obj) { return false; }
 
     /**
-        Returns @true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+        Returns @true if this object is top-level, i.e.\ contains its own paragraphs, such as a text box.
     */
     virtual bool IsTopLevel(wxRichTextField* obj) const { return true; }
 

diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h
index 8fef5ca9902ec83d3dde71131435e08618ef20df..862b297d22eef79d51124a492552231c2fe23ce7 100644 (file)
--- a/interface/wx/richtext/richtextctrl.h
+++ b/interface/wx/richtext/richtextctrl.h
@@ -1890,7 +1890,7 @@ public:
     virtual void PaintBackground(wxDC& dc);
 
     /**
-        Other user defined painting after everything else (i.e. all text) is painted.
+        Other user defined painting after everything else (i.e.\ all text) is painted.
 
         @since 2.9.1
     */