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
This commit is contained in:
Vadim Zeitlin
2013-05-31 23:20:53 +00:00
parent a2d65663a0
commit 3746766367
4 changed files with 16 additions and 16 deletions

View File

@@ -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.