solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Escape all "__" in Doxygen to preserve them in the output

Browse source 
New version of Doxygen interprets __foo__ as Markdown markup and
consumes the underscores, which mangles the identifier.

Prevent this from happening by escaping the leading underscore for all
occurrences of "__" outside of the code blocks, this seems to be the
least intrusive fix.

See #22671.
This commit is contained in:
Vadim Zeitlin 2022-07-30 14:56:23 +02:00
parent 0e57ed1851
commit 57bf9c5af5
11 changed files with 92 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

150
docs/doxygen/mainpages/const_cpp.h
View file

@ -23,43 +23,43 @@ using @ifdef_ and not @if_.
@section page_cppconst_guisystem GUI system
@beginDefList
@itemdef{__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI == 0)}
@itemdef{__WXDFB__, wxUniversal using DirectFB}
@itemdef{__WXGTK__, GTK+}
@itemdef{__WXGTK127__, GTK+ 1.2.7 or higher}
@itemdef{__WXGTK20__, GTK+ 2.0 (2.6) or higher}
@itemdef{__WXGTK210__, GTK+ 2.10 or higher}
@itemdef{__WXGTK218__, GTK+ 2.18 or higher}
@itemdef{__WXGTK220__, GTK+ 2.20 or higher}
@itemdef{__WXMAC__, old define, same as <tt>__WXOSX__</tt>}
@itemdef{__WXMOTIF__, Motif}
@itemdef{__WXMOTIF20__, Motif 2.0 or higher}
@itemdef{__WXMSW__, GUI using <a href="http://en.wikipedia.org/wiki/Windows_User">Windows Controls</a>.
@itemdef{\__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI == 0)}
@itemdef{\__WXDFB__, wxUniversal using DirectFB}
@itemdef{\__WXGTK__, GTK+}
@itemdef{\__WXGTK127__, GTK+ 1.2.7 or higher}
@itemdef{\__WXGTK20__, GTK+ 2.0 (2.6) or higher}
@itemdef{\__WXGTK210__, GTK+ 2.10 or higher}
@itemdef{\__WXGTK218__, GTK+ 2.18 or higher}
@itemdef{\__WXGTK220__, GTK+ 2.20 or higher}
@itemdef{\__WXMAC__, old define, same as <tt>\__WXOSX__</tt>}
@itemdef{\__WXMOTIF__, Motif}
@itemdef{\__WXMOTIF20__, Motif 2.0 or higher}
@itemdef{\__WXMSW__, GUI using <a href="http://en.wikipedia.org/wiki/Windows_User">Windows Controls</a>.
Notice that for compatibility reasons, this symbol is defined for console
applications under Windows as well, but it should only be used in the GUI code
while <tt>__WINDOWS__</tt> should be used for the platform tests.}
@itemdef{__WXOSX__, OS X GUI using any Apple widget framework (AppKit or UIKit)}
@itemdef{__WXOSX_IPHONE__, iPhone (UIKit)}
@itemdef{__WXOSX_COCOA__, macOS using Cocoa (AppKit)}
@itemdef{__WXOSX_MAC__, macOS (Cocoa)}
@itemdef{__WXPM__, OS/2 native Presentation Manager (not used any longer).}
@itemdef{__WXXT__, Xt; mutually exclusive with WX_MOTIF, not implemented in wxWidgets 2.x}
@itemdef{__WXX11__, wxX11 (<tt>__WXUNIVERSAL__</tt> will be also defined)}
@itemdef{__WXWINE__, WINE (i.e. WIN32 on Unix)}
@itemdef{__WXUNIVERSAL__, wxUniversal port, always defined in addition
while <tt>\__WINDOWS__</tt> should be used for the platform tests.}
@itemdef{\__WXOSX__, OS X GUI using any Apple widget framework (AppKit or UIKit)}
@itemdef{\__WXOSX_IPHONE__, iPhone (UIKit)}
@itemdef{\__WXOSX_COCOA__, macOS using Cocoa (AppKit)}
@itemdef{\__WXOSX_MAC__, macOS (Cocoa)}
@itemdef{\__WXPM__, OS/2 native Presentation Manager (not used any longer).}
@itemdef{\__WXXT__, Xt; mutually exclusive with WX_MOTIF, not implemented in wxWidgets 2.x}
@itemdef{\__WXX11__, wxX11 (<tt>\__WXUNIVERSAL__</tt> will be also defined)}
@itemdef{\__WXWINE__, WINE (i.e. WIN32 on Unix)}
@itemdef{\__WXUNIVERSAL__, wxUniversal port, always defined in addition
to one of the symbols above so this should be tested first.}
@itemdef{__X__, any X11-based GUI toolkit except GTK+}
@itemdef{\__X__, any X11-based GUI toolkit except GTK+}
@endDefList
wxOSX is the successor of the venerable wxMac, it currently exists in two
versions: Cocoa for the desktop and a very early iPhone port. To summarize:
@li If you want to test for wxOSX on the desktop, use
<tt>__WXOSX_MAC__</tt>.
<tt>\__WXOSX_MAC__</tt>.
@li If you want to test for wxOSX on the iPhone, use
<tt>__WXOSX_IPHONE__</tt>.
<tt>\__WXOSX_IPHONE__</tt>.
@li If you want to test for any port under macOS, including, for
example, wxGTK and also wxBase, use <tt>__DARWIN__</tt> (see below).
example, wxGTK and also wxBase, use <tt>\__DARWIN__</tt> (see below).
The convention is to use the <tt>__WX</tt> prefix for these
symbols, although this has not always been followed.
@ -69,34 +69,34 @@ symbols, although this has not always been followed.
@section page_cppconst_os Operating Systems
@beginDefList
@itemdef{__APPLE__, any Mac OS version}
@itemdef{__AIX__, AIX}
@itemdef{__BSD__, Any *BSD system}
@itemdef{__CYGWIN__, Cygwin: Unix on Win32}
@itemdef{__DARWIN__, OS X (with BSD C library), using any port (see also <tt>__WXOSX__</tt>)}
@itemdef{__DATA_GENERAL__, DG-UX}
@itemdef{__FREEBSD__, FreeBSD}
@itemdef{__HPUX__, HP-UX (Unix)}
@itemdef{__GNU__, GNU Hurd}
@itemdef{__LINUX__, Linux}
@itemdef{__MACH__, Mach-O Architecture (OS X only builds)}
@itemdef{__OSF__, OSF/1}
@itemdef{__QNX__, QNX Neutrino RTOS}
@itemdef{__SGI__, IRIX}
@itemdef{__SOLARIS__, Solaris}
@itemdef{__SUN__, Any Sun}
@itemdef{__SUNOS__, Sun OS}
@itemdef{__SVR4__, SystemV R4}
@itemdef{__SYSV__, SystemV generic}
@itemdef{__ULTRIX__, Ultrix}
@itemdef{__UNIX__, any Unix}
@itemdef{__UNIX_LIKE__, Unix, BeOS or VMS}
@itemdef{__VMS__, VMS}
@itemdef{__WINDOWS__, Any Windows platform, using any port (see also <tt>__WXMSW__</tt>)}
@itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)}
@itemdef{__WIN32__, Win32 API}
@itemdef{__WIN64__, Win64 (mostly same as Win32 but data type sizes are different)}
@itemdef{__WINE__, Wine}
@itemdef{\__APPLE__, any Mac OS version}
@itemdef{\__AIX__, AIX}
@itemdef{\__BSD__, Any *BSD system}
@itemdef{\__CYGWIN__, Cygwin: Unix on Win32}
@itemdef{\__DARWIN__, OS X (with BSD C library), using any port (see also <tt>\__WXOSX__</tt>)}
@itemdef{\__DATA_GENERAL__, DG-UX}
@itemdef{\__FREEBSD__, FreeBSD}
@itemdef{\__HPUX__, HP-UX (Unix)}
@itemdef{\__GNU__, GNU Hurd}
@itemdef{\__LINUX__, Linux}
@itemdef{\__MACH__, Mach-O Architecture (OS X only builds)}
@itemdef{\__OSF__, OSF/1}
@itemdef{\__QNX__, QNX Neutrino RTOS}
@itemdef{\__SGI__, IRIX}
@itemdef{\__SOLARIS__, Solaris}
@itemdef{\__SUN__, Any Sun}
@itemdef{\__SUNOS__, Sun OS}
@itemdef{\__SVR4__, SystemV R4}
@itemdef{\__SYSV__, SystemV generic}
@itemdef{\__ULTRIX__, Ultrix}
@itemdef{\__UNIX__, any Unix}
@itemdef{\__UNIX_LIKE__, Unix, BeOS or VMS}
@itemdef{\__VMS__, VMS}
@itemdef{\__WINDOWS__, Any Windows platform, using any port (see also <tt>\__WXMSW__</tt>)}
@itemdef{\__WIN16__, Win16 API (not supported since wxWidgets 2.6)}
@itemdef{\__WIN32__, Win32 API}
@itemdef{\__WIN64__, Win64 (mostly same as Win32 but data type sizes are different)}
@itemdef{\__WINE__, Wine}
@endDefList
@ -107,10 +107,10 @@ Note that not all of these symbols are always defined, it depends on the
compiler used.
@beginDefList
@itemdef{__ALPHA__, DEC Alpha architecture}
@itemdef{__INTEL__, Intel i386 or compatible}
@itemdef{__IA64__, Intel 64 bit architecture}
@itemdef{__POWERPC__, Motorola Power PC}
@itemdef{\__ALPHA__, DEC Alpha architecture}
@itemdef{\__INTEL__, Intel i386 or compatible}
@itemdef{\__IA64__, Intel 64 bit architecture}
@itemdef{\__POWERPC__, Motorola Power PC}
@endDefList
@ -118,28 +118,28 @@ compiler used.
@section page_cppconst_compiler Compilers
@beginDefList
@itemdef{__BORLANDC__, Borland C++. The value of the macro corresponds
@itemdef{\__BORLANDC__, Borland C++. The value of the macro corresponds
to the compiler version: 500 is 5.0 (not used any more).}
@itemdef{__DIGITALMARS__, Digital Mars (not used any more).}
@itemdef{__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION}
@itemdef{__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION}
@itemdef{__INTELC__, Intel C++ compiler}
@itemdef{__MINGW32__, Either MinGW32 or MinGW-w64 in either 32 or 64 bits}
@itemdef{\__DIGITALMARS__, Digital Mars (not used any more).}
@itemdef{\__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION}
@itemdef{\__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION}
@itemdef{\__INTELC__, Intel C++ compiler}
@itemdef{\__MINGW32__, Either MinGW32 or MinGW-w64 in either 32 or 64 bits}
@itemdef{__MINGW32_TOOLCHAIN, MinGW32 only (32 bits only right now)}
@itemdef{__MINGW64__, MinGW-w64 in 64 bit builds}
@itemdef{__MINGW64_TOOLCHAIN__, MinGW-w64 in either 32 or 64 bit builds}
@itemdef{__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION}
@itemdef{__SYMANTECC__, Symantec C++ (not used any more).}
@itemdef{__VISAGECPP__, IBM Visual Age (OS/2) (not used any more).}
@itemdef{__VISUALC__, Microsoft Visual C++, see also ::wxCHECK_VISUALC_VERSION.
@itemdef{\__MINGW64__, MinGW-w64 in 64 bit builds}
@itemdef{\__MINGW64_TOOLCHAIN__, MinGW-w64 in either 32 or 64 bit builds}
@itemdef{\__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION}
@itemdef{\__SYMANTECC__, Symantec C++ (not used any more).}
@itemdef{\__VISAGECPP__, IBM Visual Age (OS/2) (not used any more).}
@itemdef{\__VISUALC__, Microsoft Visual C++, see also ::wxCHECK_VISUALC_VERSION.
The value of this macro corresponds to the compiler version:
@c 1020 for @c 4.2 (the first supported version), @c 1100 for
@c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
__VISUALCn__ are also defined for each major compiler version from
\__VISUALCn__ are also defined for each major compiler version from
5 to 12, i.e. you can use tests such as <tt>\#ifdef \_\_VISUALC7\_\_</tt>
to test for compiler version being precisely 7.}
@itemdef{__XLC__, AIX compiler}
@itemdef{__WATCOMC__, Watcom C++. The value of this macro corresponds to
@itemdef{\__XLC__, AIX compiler}
@itemdef{\__WATCOMC__, Watcom C++. The value of this macro corresponds to
the compiler version, @c 1100 is @c 11.0 and @c 1200 is OpenWatcom
(not used any more).}
@endDefList
@ -347,12 +347,12 @@ more details.
@section page_cppconst_miscellaneous Miscellaneous
@beginDefList
@itemdef{__WXWINDOWS__,
@itemdef{\__WXWINDOWS__,
always defined in wxWidgets applications, see also wxCHECK_VERSION}
@itemdef{wxDEBUG_LEVEL, defined as 1 by default, may be pre-defined as 0 before
including wxWidgets headers to disable generation of any code at all
for the assertion macros, see @ref overview_debugging}
@itemdef{__WXDEBUG__, defined if wxDEBUG_LEVEL is 1 or more, undefined otherwise}
@itemdef{\__WXDEBUG__, defined if wxDEBUG_LEVEL is 1 or more, undefined otherwise}
@itemdef{wxUSE_XXX,
if defined as 1, feature XXX is active, see the
@ref page_wxusedef (the symbols of this form are always defined,

2
docs/doxygen/mainpages/const_wxusedef.h
View file

@ -158,7 +158,7 @@ library:
@itemdef{wxUSE_LISTBOX, Use wxListBox class.}
@itemdef{wxUSE_LISTCTRL, Use wxListCtrl class.}
@itemdef{wxUSE_LOG, Use wxLog and related classes.}
@itemdef{wxUSE_LOG_DEBUG, Enabled when wxLog used with __WXDEBUG__ defined.}
@itemdef{wxUSE_LOG_DEBUG, Enabled when wxLog used with \__WXDEBUG__ defined.}
@itemdef{wxUSE_LOG_DIALOG, Use wxLogDialog class.}
@itemdef{wxUSE_LOGGUI, Use wxLogGui class.}
@itemdef{wxUSE_LOGWINDOW, Use wxLogFrame class.}

2
docs/doxygen/overviews/log.h
View file

@ -48,7 +48,7 @@ of arguments or a variable argument list pointer. Here are all of them:
message. The second form of this function takes the error code explicitly
as the first argument.
@li wxLogDebug() is @b the right function for debug output. It only does anything
at all in the debug mode (when the preprocessor symbol @c __WXDEBUG__ is
at all in the debug mode (when the preprocessor symbol @c \__WXDEBUG__ is
defined) and expands to nothing in release mode (otherwise).
Note that under Windows, you must either run the program under debugger or
use a 3rd party program such as DebugView

4
interface/wx/app.h
View file

@ -274,7 +274,7 @@ public:
This function is called when an assert failure occurs, i.e.\ the condition
specified in wxASSERT() macro evaluated to @false.
It is only called in debug mode (when @c __WXDEBUG__ is defined) as
It is only called in debug mode (when @c \__WXDEBUG__ is defined) as
asserts are not left in the release code at all.
The base class version shows the default assert failure dialog box proposing to
the user to stop the program, continue or ignore all subsequent asserts.
@ -285,7 +285,7 @@ public:
the line number in this file where the assert occurred
@param func
the name of the function where the assert occurred, may be
empty if the compiler doesn't support C99 __FUNCTION__
empty if the compiler doesn't support C99 \__FUNCTION__
@param cond
the condition of the failed assert in text form
@param msg

2
interface/wx/cpp.h
View file

@ -49,7 +49,7 @@
/**
This macro expands to the name of the current function if the compiler
supports any of @c __FUNCTION__, @c __func__ or equivalent variables or
supports any of @c \__FUNCTION__, @c \__func__ or equivalent variables or
macros or to @NULL if none of them is available.
@header{wx/cpp.h}

4
interface/wx/debug.h
View file

@ -143,7 +143,7 @@ typedef void (*wxAssertHandler_t)(const wxString& file,
default.
It is mostly useful for asserting inside functions called from macros, as
by passing the usual @c __FILE__, @c __LINE__ and @c __FUNCTION__ values to
by passing the usual @c \__FILE__, @c \__LINE__ and @c \__FUNCTION__ values to
a function, it's possible to pretend that the assert happens at the
location of the macro in the source code (which can be useful) instead of
inside the function itself (which is never useful as these values are
@ -229,7 +229,7 @@ typedef void (*wxAssertHandler_t)(const wxString& file,
sometimes desirable to test them at the compile time.
Note that this macro internally declares a struct whose name it tries to
make unique by using the @c __LINE__ in it but it may still not work if you
make unique by using the @c \__LINE__ in it but it may still not work if you
use it on the same line in two different source files. In this case you may
either change the line in which either of them appears on or use the
wxCOMPILE_TIME_ASSERT2() macro.

6
interface/wx/defs.h
View file

@ -1519,7 +1519,7 @@ typedef double wxDouble;
/**
Returns @true if the compiler being used supports the given C++ version.
The @a stdver parameter uses the same values as the standard @c __cplusplus
The @a stdver parameter uses the same values as the standard @c \__cplusplus
macro, i.e.
- 201103L for C++11
@ -1527,8 +1527,8 @@ typedef double wxDouble;
- 201703L for C++17
- 202002L for C++20
Using this macro also works with MSVC, even when @c /Zc:__cplusplus option
is not used, unlike checking for the value of @c __cplusplus directly.
Using this macro also works with MSVC, even when @c /Zc:\__cplusplus option
is not used, unlike checking for the value of @c \__cplusplus directly.
@since 3.1.7

4
interface/wx/log.h
View file

@ -49,7 +49,7 @@ public:
/**
The name of the function where the log record was generated.
This field may be @NULL if the compiler doesn't support @c __FUNCTION__
This field may be @NULL if the compiler doesn't support @c \__FUNCTION__
(but most modern compilers do).
*/
const char *func;
@ -1492,7 +1492,7 @@ void wxVLogTrace(wxTraceMask mask, const char* formatString, va_list argPtr);
//@{
/**
The right functions for debug output. They only do something in debug mode
(when the preprocessor symbol @c __WXDEBUG__ is defined) and expand to
(when the preprocessor symbol @c \__WXDEBUG__ is defined) and expand to
nothing in release mode (otherwise).
@header{wx/log.h}

4
interface/wx/memory.h
View file

@ -12,7 +12,7 @@
A class for performing various debugging and memory tracing operations.
Full functionality (such as printing out objects currently allocated) is
only present in a debugging build of wxWidgets, i.e. if the __WXDEBUG__
only present in a debugging build of wxWidgets, i.e. if the @c \__WXDEBUG__
symbol is defined. wxDebugContext and related functions and macros can be
compiled out by setting wxUSE_DEBUG_CONTEXT to 0 is setup.h
@ -126,7 +126,7 @@ public:
information about memory allocation. Otherwise, a straight malloc and free
will be performed by these operators.
By default, debug mode is on if __WXDEBUG__ is defined. If the application
By default, debug mode is on if @c \__WXDEBUG__ is defined. If the application
uses this function, it should make sure that all object memory allocated
is deallocated with the same value of debug mode. Otherwise, the delete
operator might try to look for memory information that does not exist.

4
interface/wx/object.h
View file

@ -337,7 +337,7 @@ public:
/**
The @e delete operator is defined for debugging versions of the library only,
when the identifier @c __WXDEBUG__ is defined.
when the identifier @c \__WXDEBUG__ is defined.
It takes over memory deallocation, allowing wxDebugContext operations.
*/
@ -345,7 +345,7 @@ public:
/**
The @e new operator is defined for debugging versions of the library only, when
the identifier @c __WXDEBUG__ is defined.
the identifier @c \__WXDEBUG__ is defined.
It takes over memory allocation, allowing wxDebugContext operations.
*/

2
interface/wx/utils.h
View file

@ -1140,7 +1140,7 @@ wxString wxGetNativeCpuArchitectureName();
case it's not available, then this function will return a ::wxLinuxDistributionInfo
structure containing empty strings.
This function is Linux-specific and is only available when the @c __LINUX__
This function is Linux-specific and is only available when the @c \__LINUX__
symbol is defined.
*/
wxLinuxDistributionInfo wxGetLinuxDistributionInfo();