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

Fix use of Doxygen @addtogroup command

Browse source 
Put Doxygen grouping constructs ("@{" and "@}") in Doxygen comments
rather than plain C++ ones to make them actually take effect. Some old
Doxygen versions (~1.8.5) did recognize them even in plain comments, but
the currently uses 1.9.1 one does not and @addtogroup didn't have any
effect as the result.

This fixes the problem with the "Functions by Category" pages being
empty in the resulting HTML documentation.

See #22572.
This commit is contained in:
Vadim Zeitlin 2022-08-03 18:28:06 +02:00
parent eb1242cc1c
commit bd92523bc5
56 changed files with 235 additions and 235 deletions
Download patch file Download diff file Expand all files Collapse all files

4
interface/wx/aboutdlg.h
View file

@ -325,7 +325,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
This function shows the standard about dialog containing the information
@ -374,4 +374,4 @@ void wxAboutBox(const wxAboutDialogInfo& info, wxWindow* parent = NULL);
*/
void wxGenericAboutBox(const wxAboutDialogInfo& info, wxWindow* parent = NULL);
//@}
///@}

8
interface/wx/access.h
View file

@ -232,7 +232,7 @@ enum wxAccSelectionFlags
wxACC_SEL_REMOVESELECTION = 16
};
//@{
///@{
/**
Represents a status of the system.
*/
@ -262,9 +262,9 @@ enum wxAccSelectionFlags
#define wxACC_STATE_SYSTEM_SELECTED 0x00800000
#define wxACC_STATE_SYSTEM_SELFVOICING 0x01000000
#define wxACC_STATE_SYSTEM_UNAVAILABLE 0x02000000
//@}
///@}
//@{
///@{
/**
An event identifier that can be sent via wxAccessible::NotifyEvent.
*/
@ -310,7 +310,7 @@ enum wxAccSelectionFlags
#define wxACC_EVENT_OBJECT_HELPCHANGE 0x8010
#define wxACC_EVENT_OBJECT_DEFACTIONCHANGE 0x8011
#define wxACC_EVENT_OBJECT_ACCELERATORCHANGE 0x8012
//@}
///@}
/**
@class wxAccessible

16
interface/wx/app.h
View file

@ -1172,7 +1172,7 @@ public:
/** @addtogroup group_funcmacro_rtti */
//@{
///@{
/**
This is used in headers to create a forward declaration of the ::wxGetApp()
@ -1277,7 +1277,7 @@ public:
*/
#define wxIMPLEMENT_WXWIN_MAIN_CONSOLE
//@}
///@}
@ -1293,7 +1293,7 @@ wxApp *wxTheApp;
/** @addtogroup group_funcmacro_appinitterm */
//@{
///@{
/**
This function doesn't exist in wxWidgets but it is created by using the
@ -1426,12 +1426,12 @@ int wxEntry(HINSTANCE hInstance,
char* pCmdLine = NULL,
int nCmdShow = SW_SHOWNORMAL);
//@}
///@}
/** @addtogroup group_funcmacro_procctrl */
//@{
///@{
/**
Exits application after calling wxApp::OnExit.
@ -1444,10 +1444,10 @@ int wxEntry(HINSTANCE hInstance,
*/
void wxExit();
//@}
///@}
/** @addtogroup group_funcmacro_debug */
//@{
///@{
/**
@def wxDISABLE_DEBUG_SUPPORT()
@ -1478,5 +1478,5 @@ void wxExit();
wxDISABLE_ASSERTS_IN_RELEASE_BUILD(); \
wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()
//@}
///@}

4
interface/wx/arrstr.h
View file

@ -498,7 +498,7 @@ int wxCmpNaturalGeneric(const wxString& s1, const wxString& s2);
// ============================================================================
/** @addtogroup group_funcmacro_string */
//@{
///@{
/**
Splits the given wxString object using the separator @a sep and returns the
@ -543,5 +543,5 @@ wxArrayString wxSplit(const wxString& str, const wxChar sep,
wxString wxJoin(const wxArrayString& arr, const wxChar sep,
const wxChar escape = '\\');
//@}
///@}

4
interface/wx/atomic.h
View file

@ -11,7 +11,7 @@
// ============================================================================
/** @addtogroup group_funcmacro_atomic */
//@{
///@{
/**
This function increments @a value in an atomic manner.
@ -44,5 +44,5 @@ wxInt32 wxAtomicInc(wxAtomicInt& value);
*/
wxInt32 wxAtomicDec(wxAtomicInt& value);
//@}
///@}

4
interface/wx/base64.h
View file

@ -11,7 +11,7 @@
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Elements of this enum specify the possible behaviours of wxBase64Decode
@ -187,5 +187,5 @@ wxMemoryBuffer wxBase64Decode(const wxString& src,
wxBase64DecodeMode mode = wxBase64DecodeMode_Strict,
size_t *posErr = NULL);
//@}
///@}

4
interface/wx/chartype.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_string */
//@{
///@{
/**
This macro can be used with character and string literals (in other words,
@ -134,4 +134,4 @@ typedef wxUSE_UNICODE_dependent wxUChar;
*/
typedef wxUSE_UNICODE_WCHAR_dependent wxStringCharType;
//@}
///@}

16
interface/wx/choicdlg.h
View file

@ -263,7 +263,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Same as wxGetSingleChoice() but returns the index representing the
@ -310,10 +310,10 @@ int wxGetSingleChoiceIndex(const wxString& message,
int n, const wxString *choices,
int initialSelection,
wxWindow *parent = NULL);
//@}
///@}
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Pops up a dialog box containing a message, OK/Cancel buttons and a
@ -370,10 +370,10 @@ wxString wxGetSingleChoice(const wxString& message,
int initialSelection,
wxWindow *parent = NULL);
//@}
///@}
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Same as wxGetSingleChoice but takes an array of client data pointers
@ -426,10 +426,10 @@ void* wxGetSingleChoiceData(const wxString& message,
int initialSelection,
wxWindow *parent = NULL);
//@}
///@}
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Pops up a dialog box containing a message, OK/Cancel buttons and a
@ -477,5 +477,5 @@ int wxGetSelectedChoices(wxArrayInt& selections,
int width = wxCHOICE_WIDTH,
int height = wxCHOICE_HEIGHT);
//@}
///@}

4
interface/wx/colordlg.h
View file

@ -138,7 +138,7 @@ wxEventType wxEVT_COLOUR_CHANGED;
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Shows the colour selection dialog and returns the colour selected by user
@ -163,5 +163,5 @@ wxColour wxGetColourFromUser(wxWindow* parent,
const wxString& caption = wxEmptyString,
wxColourData* data = NULL);
//@}
///@}

12
interface/wx/colour.h
View file

@ -10,14 +10,14 @@
/**
Flags for wxColour -> wxString conversion (see wxColour::GetAsString).
*/
//@{
///@{
enum {
wxC2S_NAME = 1, // return colour name, when possible
wxC2S_CSS_SYNTAX = 2, // return colour in rgb(r,g,b) syntax
wxC2S_HTML_SYNTAX = 4 // return colour in #rrggbb syntax
};
//@}
///@}
const unsigned char wxALPHA_TRANSPARENT = 0;
const unsigned char wxALPHA_OPAQUE = 0xff;
@ -356,7 +356,7 @@ public:
/** @name Predefined colors. */
//@{
///@{
wxColour wxNullColour;
wxColour wxTransparentColour;
wxColour* wxBLACK;
@ -367,7 +367,7 @@ wxColour* wxYELLOW;
wxColour* wxLIGHT_GREY;
wxColour* wxRED;
wxColour* wxWHITE;
//@}
///@}
@ -376,7 +376,7 @@ wxColour* wxWHITE;
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Converts string to a wxColour best represented by the given string. Returns
@ -397,5 +397,5 @@ bool wxFromString(const wxString& string, wxColour* colour);
*/
wxString wxToString(const wxColour& colour);
//@}
///@}

8
interface/wx/cpp.h
View file

@ -7,7 +7,7 @@
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
This macro returns the concatenation of the arguments passed. Unlike when
using the preprocessor operator, the arguments undergo macro expansion
@ -19,10 +19,10 @@
#define wxCONCAT3(x1, x2, x3)
#define wxCONCAT4(x1, x2, x3, x4)
#define wxCONCAT5(x1, x2, x3, x4, x5)
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Returns the string representation of the given symbol which can be either a
@ -56,5 +56,5 @@
*/
#define __WXFUNCTION__
//@}
///@}

4
interface/wx/cursor.h
View file

@ -250,10 +250,10 @@ public:
@see wxStockCursor
*/
//@{
///@{
wxCursor wxNullCursor;
wxCursor* wxSTANDARD_CURSOR;
wxCursor* wxHOURGLASS_CURSOR;
wxCursor* wxCROSS_CURSOR;
//@}
///@}

4
interface/wx/dde.h
View file

@ -323,7 +323,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Called when wxWidgets exits, to clean up the DDE system. This no longer
@ -347,5 +347,5 @@ void wxDDECleanUp();
*/
void wxDDEInitialize();
//@}
///@}

4
interface/wx/debug.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_debug */
//@{
///@{
/**
Exits the program immediately.
@ -410,5 +410,5 @@ void wxSetDefaultAssertHandler();
*/
void wxTrap();
//@}
///@}

40
interface/wx/defs.h
View file

@ -1357,7 +1357,7 @@ enum wxUpdateUI
wxINTn_MAX and @c wxUINTc_MAX (@c wxUINTc_MIN is always 0 and so is not
defined).
*/
//@{
///@{
#define wxINT8_MIN CHAR_MIN
#define wxINT8_MAX CHAR_MAX
#define wxUINT8_MAX UCHAR_MAX
@ -1373,7 +1373,7 @@ enum wxUpdateUI
#define wxINT64_MIN LLONG_MIN
#define wxINT64_MAX LLONG_MAX
#define wxUINT64_MAX ULLONG_MAX
//@}
///@}
// ----------------------------------------------------------------------------
// types
@ -1385,36 +1385,36 @@ typedef int wxCoord;
/** A special value meaning "use default coordinate". */
wxCoord wxDefaultCoord = -1;
//@{
///@{
/** 8 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
typedef signed char wxInt8;
typedef unsigned char wxUint8;
typedef wxUint8 wxByte;
//@}
///@}
//@{
///@{
/** 16 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
typedef signed short wxInt16;
typedef unsigned short wxUint16;
typedef wxUint16 wxWord;
typedef wxUint16 wxChar16;
//@}
///@}
//@{
///@{
/** 32 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
typedef int wxInt32;
typedef unsigned int wxUint32;
typedef wxUint32 wxDword;
typedef wxUint32 wxChar32;
//@}
///@}
//@{
///@{
/** 64 bit type (the mapping is more complex than a simple @c typedef and is not shown here). */
typedef wxLongLong_t wxInt64;
typedef wxULongLong_t wxUint64;
//@}
///@}
//@{
///@{
/**
Signed and unsigned integral types big enough to contain all of @c long,
@c size_t and @c void*.
@ -1422,7 +1422,7 @@ typedef wxULongLong_t wxUint64;
*/
typedef ssize_t wxIntPtr;
typedef size_t wxUIntPtr;
//@}
///@}
/**
@ -1453,7 +1453,7 @@ typedef double wxDouble;
/** @addtogroup group_funcmacro_byteorder */
//@{
///@{
/**
This macro will swap the bytes of the @a value variable from little endian
@ -1467,10 +1467,10 @@ typedef double wxDouble;
#define wxINT16_SWAP_ALWAYS( wxInt16_value )
#define wxUINT16_SWAP_ALWAYS( wxUint16_value )
//@}
///@}
/** @addtogroup group_funcmacro_byteorder */
//@{
///@{
/**
This macro will swap the bytes of the @a value variable from little endian
@ -1488,10 +1488,10 @@ typedef double wxDouble;
#define wxINT16_SWAP_ON_BE( wxInt16_value )
#define wxUINT16_SWAP_ON_BE( wxUint16_value )
//@}
///@}
/** @addtogroup group_funcmacro_byteorder */
//@{
///@{
/**
This macro will swap the bytes of the @a value variable from little endian
@ -1509,12 +1509,12 @@ typedef double wxDouble;
#define wxINT16_SWAP_ON_LE( wxInt16_value )
#define wxUINT16_SWAP_ON_LE( wxUint16_value )
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Returns @true if the compiler being used supports the given C++ version.
@ -1894,6 +1894,6 @@ template <typename T> void wxSwap(T& first, T& second);
*/
void wxVaCopy(va_list argptrDst, va_list argptrSrc);
//@}
///@}

4
interface/wx/dirdlg.h
View file

@ -162,7 +162,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Pops up a directory selector dialog. The arguments have the same meaning
@ -188,5 +188,5 @@ wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr,
const wxPoint& pos = wxDefaultPosition,
wxWindow* parent = NULL);
//@}
///@}

4
interface/wx/dnd.h
View file

@ -429,7 +429,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
This macro creates either a cursor (MSW) or an icon (elsewhere) with the
@ -451,5 +451,5 @@ public:
*/
bool wxIsDragResultOk(wxDragResult res);
//@}
///@}

4
interface/wx/docview.h
View file

@ -1720,7 +1720,7 @@ protected:
// ============================================================================
/** @addtogroup group_funcmacro_file */
//@{
///@{
/**
Copies the given file to @a stream. Useful when converting an old
@ -1742,5 +1742,5 @@ bool wxTransferFileToStream(const wxString& filename,
bool wxTransferStreamToFile(istream& stream,
const wxString& filename);
//@}
///@}

20
interface/wx/dynarray.h
View file

@ -665,7 +665,7 @@ public:
*/
#define WX_CLEAR_ARRAY(wxArray_arrayToBeCleared)
//@{
///@{
/**
This macro declares a new object array class named @a name and containing
the elements of type @e T.
@ -687,9 +687,9 @@ public:
#define WX_DECLARE_OBJARRAY(T, name)
#define WX_DECLARE_EXPORTED_OBJARRAY(T, name)
#define WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, expmode)
//@}
///@}
//@{
///@{
/**
This macro defines a new array class named @a name and containing the
elements of type @a T.
@ -714,9 +714,9 @@ public:
#define WX_DEFINE_ARRAY(T, name)
#define WX_DEFINE_EXPORTED_ARRAY(T, name)
#define WX_DEFINE_USER_EXPORTED_ARRAY(T, name, exportspec)
//@}
///@}
//@{
///@{
/**
This macro defines the methods of the array class @a name not defined by
the WX_DECLARE_OBJARRAY() macro. You must include the file
@ -752,9 +752,9 @@ public:
#define WX_DEFINE_OBJARRAY(name)
#define WX_DEFINE_EXPORTED_OBJARRAY(name)
#define WX_DEFINE_USER_EXPORTED_OBJARRAY(name)
//@}
///@}
//@{
///@{
/**
This macro defines a new sorted array class named @a name and containing
the elements of type @e T.
@ -795,7 +795,7 @@ public:
#define WX_DEFINE_SORTED_ARRAY(T, name)
#define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name)
#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(T, name, expmode)
//@}
///@}
/**
This macro may be used to prepend all elements of the @a wxArray_arrayToBePrepended
@ -803,7 +803,7 @@ public:
*/
#define WX_PREPEND_ARRAY(wxArray_arrayToModify, wxArray_arrayToBePrepended)
//@{
///@{
/**
Predefined specialization of wxArray<T> for standard types.
*/
@ -812,4 +812,4 @@ typedef wxArray<long> wxArrayLong;
typedef wxArray<short> wxArrayShort;
typedef wxArray<double> wxArrayDouble;
typedef wxArray<void*> wxArrayPtrVoid;
//@}
///@}

4
interface/wx/dynlib.h
View file

@ -268,7 +268,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
When loading a function from a DLL you always have to cast the returned
@ -293,5 +293,5 @@ public:
*/
#define wxDYNLIB_FUNCTION(type, name, dynlib)
//@}
///@}

4
interface/wx/event.h
View file

@ -4919,7 +4919,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_events */
//@{
///@{
#if wxUSE_BASE
@ -5262,4 +5262,4 @@ wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED;
#endif // wxUSE_GUI
//@}
///@}

4
interface/wx/filedlg.h
View file

@ -484,7 +484,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Pops up a file selector box. In Windows, this is the common file selector
@ -575,5 +575,5 @@ wxString wxSaveFileSelector(const wxString& what,
const wxString& default_name = wxEmptyString,
wxWindow *parent = NULL);
//@}
///@}

16
interface/wx/filefn.h
View file

@ -101,7 +101,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_file */
//@{
///@{
/**
A special return value of many wxWidgets classes to indicate that
@ -490,10 +490,10 @@ enum wxFileKind
wxFILE_KIND_PIPE ///< A pipe
};
//@}
///@}
/** @addtogroup group_funcmacro_file */
//@{
///@{
/**
Returns the type of an open file. Possible return values are enumerations
of ::wxFileKind.
@ -502,10 +502,10 @@ enum wxFileKind
*/
wxFileKind wxGetFileKind(int fd);
wxFileKind wxGetFileKind(FILE* fp);
//@}
///@}
/** @addtogroup group_funcmacro_file */
//@{
///@{
/**
@deprecated
This function is obsolete, please use wxFileName::SplitPath() instead.
@ -517,10 +517,10 @@ wxFileKind wxGetFileKind(FILE* fp);
*/
wxString wxFileNameFromPath(const wxString& path);
char* wxFileNameFromPath(char* path);
//@}
///@}
/** @addtogroup group_funcmacro_file */
//@{
///@{
/**
@deprecated
This function is obsolete, please use wxFileName::CreateTempFileName() instead.
@ -529,5 +529,5 @@ char* wxFileNameFromPath(char* path);
*/
char* wxGetTempFileName(const wxString& prefix, char* buf = NULL);
bool wxGetTempFileName(const wxString& prefix, wxString& buf);
//@}
///@}

4
interface/wx/font.h
View file

@ -1416,7 +1416,7 @@ wxFontList* wxTheFontList;
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Converts string to a wxFont best represented by the given string. Returns
@ -1437,5 +1437,5 @@ bool wxFromString(const wxString& string, wxFont* font);
*/
wxString wxToString(const wxFont& font);
//@}
///@}

4
interface/wx/fontdlg.h
View file

@ -81,7 +81,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Shows the font selection dialog and returns the font selected by user or
@ -101,5 +101,5 @@ wxFont wxGetFontFromUser(wxWindow* parent,
const wxFont& fontInit,
const wxString& caption = wxEmptyString);
//@}
///@}

32
interface/wx/gdicmn.h
View file

@ -1115,7 +1115,7 @@ const wxSize wxDefaultSize;
// ============================================================================
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
This macro loads a bitmap from either application resources (on the
@ -1239,10 +1239,10 @@ int wxDisplayDepth();
*/
void wxSetCursor(const wxCursor& cursor);
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the dimensions of the work area on the display.
@ -1257,10 +1257,10 @@ void wxSetCursor(const wxCursor& cursor);
@header{wx/gdicmn.h}
*/
void wxClientDisplayRect(int* x, int* y, int* width, int* height);
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the dimensions of the work area on the display. On Windows this
means the area not covered by the taskbar, etc. Other platforms are
@ -1272,10 +1272,10 @@ void wxClientDisplayRect(int* x, int* y, int* width, int* height);
@header{wx/gdicmn.h}
*/
wxRect wxGetClientDisplayRect();
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the display resolution in pixels per inch.
@ -1293,10 +1293,10 @@ wxRect wxGetClientDisplayRect();
@since 2.9.0
*/
wxSize wxGetDisplayPPI();
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the display size in pixels.
@ -1312,10 +1312,10 @@ wxSize wxGetDisplayPPI();
@header{wx/gdicmn.h}
*/
void wxDisplaySize(int* width, int* height);
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the display size in pixels.
@ -1328,10 +1328,10 @@ void wxDisplaySize(int* width, int* height);
@header{wx/gdicmn.h}
*/
wxSize wxGetDisplaySize();
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the display size in millimeters.
@ -1343,10 +1343,10 @@ wxSize wxGetDisplaySize();
@header{wx/gdicmn.h}
*/
void wxDisplaySizeMM(int* width, int* height);
//@}
///@}
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Returns the display size in millimeters.
@ -1355,4 +1355,4 @@ void wxDisplaySizeMM(int* width, int* height);
@header{wx/gdicmn.h}
*/
wxSize wxGetDisplaySizeMM();
//@}
///@}

4
interface/wx/image.h
View file

@ -2134,7 +2134,7 @@ wxImage wxNullImage;
// ============================================================================
/** @addtogroup group_funcmacro_appinitterm */
//@{
///@{
/**
Initializes all available image handlers.
@ -2152,5 +2152,5 @@ wxImage wxNullImage;
*/
void wxInitAllImageHandlers();
//@}
///@}

4
interface/wx/init.h
View file

@ -41,7 +41,7 @@ public:
/** @addtogroup group_funcmacro_appinitterm */
//@{
///@{
/**
This function can be used to perform the initialization of wxWidgets if you
@ -106,5 +106,5 @@ bool wxInitialize(int argc = 0, wxChar **argv = NULL);
*/
void wxUninitialize();
//@}
///@}

4
interface/wx/link.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_byteorder */
//@{
///@{
/**
This macro can be used in conjunction with the wxFORCE_LINK_MODULE() macro
@ -35,5 +35,5 @@
*/
#define wxFORCE_LINK_MODULE( moduleName )
//@}
///@}

56
interface/wx/log.h
View file

@ -1253,7 +1253,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
This function shows a message to the user in a safe way and should be safe
@ -1320,10 +1320,10 @@ wxString wxSysErrorMsgStr(unsigned long errCode = 0);
*/
const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Logs a message with the given wxLogLevel.
E.g. using @c wxLOG_Message as first argument, this function behaves like wxLogMessage().
@ -1332,10 +1332,10 @@ const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
*/
void wxLogGeneric(wxLogLevel level, const char* formatString, ... );
void wxVLogGeneric(wxLogLevel level, const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
For all normal, informational messages. They also appear in a message box
by default (but it can be changed).
@ -1344,10 +1344,10 @@ void wxVLogGeneric(wxLogLevel level, const char* formatString, va_list argPtr);
*/
void wxLogMessage(const char* formatString, ... );
void wxVLogMessage(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
For low priority messages.
@ -1358,10 +1358,10 @@ void wxVLogMessage(const char* formatString, va_list argPtr);
*/
void wxLogInfo(const char* formatString, ... );
void wxVLogInfo(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
For verbose output.
@ -1379,10 +1379,10 @@ void wxVLogInfo(const char* formatString, va_list argPtr);
*/
void wxLogVerbose(const char* formatString, ... );
void wxVLogVerbose(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
For warnings - they are also normally shown to the user, but don't
interrupt the program work.
@ -1391,10 +1391,10 @@ void wxVLogVerbose(const char* formatString, va_list argPtr);
*/
void wxLogWarning(const char* formatString, ... );
void wxVLogWarning(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Like wxLogError(), but also terminates the program with the exit code 3.
Using @e abort() standard function also terminates the program with this
@ -1404,10 +1404,10 @@ void wxVLogWarning(const char* formatString, va_list argPtr);
*/
void wxLogFatalError(const char* formatString, ... );
void wxVLogFatalError(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
The functions to use for error messages, i.e. the messages that must be
shown to the user. The default processing is to pop up a message box to
@ -1417,10 +1417,10 @@ void wxVLogFatalError(const char* formatString, va_list argPtr);
*/
void wxLogError(const char* formatString, ... );
void wxVLogError(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Log a message at @c wxLOG_Trace log level (see ::wxLogLevelValues enum).
@ -1454,10 +1454,10 @@ void wxVLogError(const char* formatString, va_list argPtr);
*/
void wxLogTrace(const char* mask, const char* formatString, ... );
void wxVLogTrace(const char* mask, const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Like wxLogDebug(), trace functions only do something in debug builds and
expand to nothing in the release one. The reason for making it a separate
@ -1486,10 +1486,10 @@ void wxVLogTrace(const char* mask, const char* formatString, va_list argPtr);
*/
void wxLogTrace(wxTraceMask mask, const char* formatString, ... );
void wxVLogTrace(wxTraceMask mask, const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
The right functions for debug output. They only do something in debug mode
(when the preprocessor symbol @c \__WXDEBUG__ is defined) and expand to
@ -1499,10 +1499,10 @@ void wxVLogTrace(wxTraceMask mask, const char* formatString, va_list argPtr);
*/
void wxLogDebug(const char* formatString, ... );
void wxVLogDebug(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Messages logged by this function will appear in the statusbar of the
@a frame or of the top level application window by default (i.e. when using
@ -1516,10 +1516,10 @@ void wxLogStatus(wxFrame* frame, const char* formatString, ... );
void wxVLogStatus(wxFrame* frame, const char* formatString, va_list argPtr);
void wxLogStatus(const char* formatString, ... );
void wxVLogStatus(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
Mostly used by wxWidgets itself, but might be handy for logging errors
after system call (API function) failure. It logs the specified message
@ -1534,10 +1534,10 @@ void wxVLogStatus(const char* formatString, va_list argPtr);
*/
void wxLogSysError(const char* formatString, ... );
void wxVLogSysError(const char* formatString, va_list argPtr);
//@}
///@}
/** @addtogroup group_funcmacro_debug */
//@{
///@{
/**
@def wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()
@ -1555,6 +1555,6 @@ void wxVLogSysError(const char* formatString, va_list argPtr);
*/
#define wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()
//@}
///@}
#endif // wxUSE_BASE

4
interface/wx/longlong.h
View file

@ -329,7 +329,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
This macro is defined to contain the @c printf() format specifier using
@ -381,5 +381,5 @@ wxLongLong_t wxLL(number);
*/
wxLongLong_t wxULL(number);
//@}
///@}

4
interface/wx/math.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_math */
//@{
///@{
/**
Returns a non-zero value if @a x is neither infinite nor NaN (not a
@ -125,5 +125,5 @@ bool wxIsNullDouble(double x);
*/
int wxMulDivInt32(int n, int numerator, int denominator);
//@}
///@}

4
interface/wx/memory.h
View file

@ -167,7 +167,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_log */
//@{
///@{
/**
@deprecated Use one of the wxLogTrace() functions or one of the
@ -219,5 +219,5 @@ void wxTrace(const wxString& format, ...);
*/
void wxTraceLevel(int level, const wxString& format, ...);
//@}
///@}

4
interface/wx/metafile.h
View file

@ -135,7 +135,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_gdi */
//@{
///@{
/**
Given a filename for an existing, valid metafile (as constructed using
@ -169,5 +169,5 @@ bool wxMakeMetafilePlaceable(const wxString& filename,
int maxX, int maxY,
float scale = 1.0);
//@}
///@}

4
interface/wx/msgdlg.h
View file

@ -292,7 +292,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Show a general purpose message dialog.
@ -340,5 +340,5 @@ int wxMessageBox(const wxString& message,
int x = wxDefaultCoord,
int y = wxDefaultCoord);
//@}
///@}

4
interface/wx/numdlg.h
View file

@ -83,7 +83,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Shows a dialog asking the user for numeric input. The dialogs title is set
@ -114,4 +114,4 @@ long wxGetNumberFromUser(const wxString& message,
wxWindow* parent = NULL,
const wxPoint& pos = wxDefaultPosition);
//@}
///@}

8
interface/wx/object.h
View file

@ -672,7 +672,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_rtti */
//@{
///@{
/**
Returns a pointer to the wxClassInfo object associated with this class.
@ -896,10 +896,10 @@ public:
*/
wxObject *wxCreateDynamicObject(const wxString& className);
//@}
///@}
/** @addtogroup group_funcmacro_debug */
//@{
///@{
/**
This is defined in debug mode to be call the redefined new operator
@ -915,5 +915,5 @@ wxObject *wxCreateDynamicObject(const wxString& className);
*/
#define WXDEBUG_NEW( arg )
//@}
///@}

4
interface/wx/platform.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_version */
//@{
///@{
/**
Returns @true if the compiler being used is GNU C++ and its version is
@ -41,5 +41,5 @@
*/
#define wxCHECK_W32API_VERSION( major, minor )
//@}
///@}

20
interface/wx/scopeguard.h
View file

@ -38,7 +38,7 @@ public:
};
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Returns a scope guard object which will call the specified function with
the given parameters on scope exit.
@ -52,10 +52,10 @@ public:
template <typename F, typename P1, ..., typename PN>
wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Ensure that the global @a function with a few (up to some
implementation-defined limit) is executed on scope exit, whether due to a
@ -80,10 +80,10 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
#define wxON_BLOCK_EXIT1(function, p1)
#define wxON_BLOCK_EXIT2(function, p1, p2)
#define wxON_BLOCK_EXIT3(function, p1, p2, p3)
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
This family of macros is similar to wxON_BLOCK_EXIT(), but calls a method
of the given object instead of a free function.
@ -95,10 +95,10 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
#define wxON_BLOCK_EXIT_OBJ1(object, method, p1)
#define wxON_BLOCK_EXIT_OBJ2(object, method, p1, p2)
#define wxON_BLOCK_EXIT_OBJ3(object, method, p1, p2, p3)
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
This family of macros is similar to wxON_BLOCK_OBJ(), but calls a method
of @c this object instead of a method of the specified object.
@ -110,10 +110,10 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
#define wxON_BLOCK_EXIT_THIS1(method, p1)
#define wxON_BLOCK_EXIT_THIS2(method, p1, p2)
#define wxON_BLOCK_EXIT_THIS3(method, p1, p2, p3)
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
This macro sets a variable to the specified value on scope exit.
@ -149,5 +149,5 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
*/
#define wxON_BLOCK_EXIT_NULL(ptr)
//@}
///@}

4
interface/wx/stockitem.h
View file

@ -65,7 +65,7 @@ enum wxStockLabelQueryFlag
};
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Returns label that should be used for given @a id element.
@ -79,5 +79,5 @@ enum wxStockLabelQueryFlag
*/
wxString wxGetStockLabel(wxWindowID id, long flags = wxSTOCK_WITH_MNEMONIC);
//@}
///@}

12
interface/wx/string.h
View file

@ -1921,7 +1921,7 @@ public:
//@{
///@{
/**
Comparison operator for string types.
*/
@ -1943,9 +1943,9 @@ inline bool operator==(const wxString& s1, const wxCharBuffer& s2);
inline bool operator==(const wxCharBuffer& s1, const wxString& s2);
inline bool operator!=(const wxString& s1, const wxCharBuffer& s2);
inline bool operator!=(const wxCharBuffer& s1, const wxString& s2);
//@}
///@}
//@{
///@{
/**
Comparison operators char types.
*/
@ -1967,7 +1967,7 @@ inline bool operator!=(const wxString& s, const wxUniChar& c);
inline bool operator!=(const wxString& s, const wxUniCharRef& c);
inline bool operator!=(const wxString& s, char c);
inline bool operator!=(const wxString& s, wchar_t c);
//@}
///@}
/**
The global wxString instance of an empty string.
@ -2099,7 +2099,7 @@ public:
/** @addtogroup group_funcmacro_string */
//@{
///@{
/**
Allows extending a function with the signature:
@ -2131,4 +2131,4 @@ template<bool (T)(const wxUniChar& c)>
*/
wxString wxASCII_STR(const char* s);
//@}
///@}

4
interface/wx/textdlg.h
View file

@ -205,7 +205,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Pop up a dialog box with title set to @e caption, @c message, and a
@ -246,5 +246,5 @@ wxString wxGetPasswordFromUser(const wxString& message,
int y = wxDefaultCoord,
bool centre = true);
//@}
///@}

4
interface/wx/thread.h
View file

@ -1721,7 +1721,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_thread */
//@{
///@{
/**
This macro declares a (static) critical section object named @a cs if
@ -1849,5 +1849,5 @@ void wxMutexGuiEnter();
*/
void wxMutexGuiLeave();
//@}
///@}

4
interface/wx/time.h
View file

@ -8,7 +8,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_time */
//@{
///@{
/**
Returns the difference between UTC and local time in seconds.
@ -69,4 +69,4 @@ wxLongLong wxGetUTCTimeMillis();
*/
wxLongLong wxGetUTCTimeUSec();
//@}
///@}

4
interface/wx/tipdlg.h
View file

@ -59,7 +59,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
This function creates a wxTipProvider which may be used with wxShowTip().
@ -99,5 +99,5 @@ bool wxShowTip(wxWindow *parent,
wxTipProvider *tipProvider,
bool showAtStartup = true);
//@}
///@}

4
interface/wx/tokenzr.h
View file

@ -166,7 +166,7 @@ public:
/** @addtogroup group_funcmacro_string */
//@{
///@{
/**
This is a convenience function wrapping wxStringTokenizer which simply
@ -184,4 +184,4 @@ wxStringTokenize(const wxString& str,
const wxString& delims = wxDEFAULT_DELIMITERS,
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
//@}
///@}

4
interface/wx/translation.h
View file

@ -444,7 +444,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_string */
//@{
///@{
/**
This macro is identical to _() but for the plural variant of
@ -617,5 +617,5 @@ const wxString& wxGetTranslation(const wxString& string,
*/
const wxString& _(const wxString& string);
//@}
///@}

4
interface/wx/txtstrm.h
View file

@ -467,7 +467,7 @@ public:
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Writes @c '\\n' to @a stream.
@ -476,4 +476,4 @@ public:
*/
wxTextOutputStream& endl(wxTextOutputStream& stream);
//@}
///@}

40
interface/wx/utils.h
View file

@ -158,7 +158,7 @@ public:
/** @addtogroup group_funcmacro_dialog */
//@{
///@{
/**
Changes the cursor to the given cursor for all windows in the application.
@ -218,10 +218,10 @@ void wxBell();
*/
void wxInfoMessageBox(wxWindow* parent);
//@}
///@}
/** @addtogroup group_funcmacro_version */
//@{
///@{
/**
Get wxWidgets version information.
@ -236,12 +236,12 @@ void wxInfoMessageBox(wxWindow* parent);
*/
wxVersionInfo wxGetLibraryVersionInfo();
//@}
///@}
/** @addtogroup group_funcmacro_env */
//@{
///@{
/**
A map type containing environment variables names and values.
@ -332,12 +332,12 @@ bool wxUnsetEnv(const wxString& var);
@since 2.9.2
*/
bool wxGetEnvMap(wxEnvVariableHashMap *map);
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Fills the memory block with zeros in a way that is guaranteed
@ -771,12 +771,12 @@ enum
*/
wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All);
//@}
///@}
/** @addtogroup group_funcmacro_networkuseros */
//@{
///@{
/**
Copies the user's email address into the supplied buffer, by concatenating
@ -1145,12 +1145,12 @@ wxString wxGetNativeCpuArchitectureName();
*/
wxLinuxDistributionInfo wxGetLinuxDistributionInfo();
//@}
///@}
/** @addtogroup group_funcmacro_procctrl */
//@{
///@{
/**
@struct wxExecuteEnv
@ -1348,10 +1348,10 @@ enum
long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
wxProcess* callback = NULL,
const wxExecuteEnv* env = NULL);
//@}
///@}
/** @addtogroup group_funcmacro_procctrl */
//@{
///@{
/**
This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
please see its documentation for general information.
@ -1387,10 +1387,10 @@ long wxExecute(const char* const* argv, int flags = wxEXEC_ASYNC,
long wxExecute(const wchar_t* const* argv, int flags = wxEXEC_ASYNC,
wxProcess* callback = NULL,
const wxExecuteEnv *env = NULL);
//@}
///@}
/** @addtogroup group_funcmacro_procctrl */
//@{
///@{
/**
This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
@ -1566,12 +1566,12 @@ bool wxShell(const wxString& command = wxEmptyString);
*/
bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF);
//@}
///@}
/** @addtogroup group_funcmacro_time */
//@{
///@{
/**
Sleeps for the specified number of microseconds. The microsecond resolution
@ -1618,11 +1618,11 @@ void wxSleep(int secs);
*/
void wxUsleep(unsigned long milliseconds);
//@}
///@}
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Convert decimal integer to 2-character hexadecimal string.
@ -1692,4 +1692,4 @@ int wxHexToDec(const wxString& buf);
@overload
*/
int wxHexToDec(const char* buf);
//@}
///@}

4
interface/wx/valnum.h
View file

@ -459,7 +459,7 @@ public:
@since 2.9.2
*/
//@{
///@{
template <typename T>
inline wxFloatingPointValidator<T>
wxMakeFloatingPointValidator(T *value, int style = wxNUM_VAL_DEFAULT);
@ -468,4 +468,4 @@ template <typename T>
inline wxFloatingPointValidator<T>
wxMakeFloatingPointValidator(int precision,
T *value, int style = wxNUM_VAL_DEFAULT);
//@}
///@}

4
interface/wx/variant.h
View file

@ -680,7 +680,7 @@ public:
// ============================================================================
/** @addtogroup group_funcmacro_rtti */
//@{
///@{
/**
This macro returns a pointer to the data stored in @a var (wxVariant) cast
@ -693,5 +693,5 @@ public:
*/
#define wxGetVariantCast(var, classname)
//@}
///@}

4
interface/wx/version.h
View file

@ -6,7 +6,7 @@
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_version */
//@{
///@{
/**
This is a macro which evaluates to @true if the current wxWidgets version
@ -39,5 +39,5 @@
*/
#define wxCHECK_VERSION_FULL( major, minor, release, subrel )
//@}
///@}

2
interface/wx/versioninfo.h
View file

@ -145,4 +145,4 @@ public:
const wxString& GetCopyright() const;
};
//@}
///@}

4
interface/wx/window.h
View file

@ -4327,7 +4327,7 @@ protected:
// ============================================================================
/** @addtogroup group_funcmacro_misc */
//@{
///@{
/**
Find the deepest window at the mouse pointer position, returning the window
@ -4372,5 +4372,5 @@ wxWindow* wxGetTopLevelParent(wxWindow* window);
*/
wxString wxDumpWindow(const wxWindow* window);
//@}
///@}

4
interface/wx/wxcrt.h
View file

@ -7,7 +7,7 @@
/** @addtogroup group_funcmacro_crt */
//@{
///@{
bool wxIsEmpty(const char *s);
bool wxIsEmpty(const wchar_t *s);
@ -223,4 +223,4 @@ wxUniChar wxTolower(const wxUniChar& c);
wxUniChar wxToupper(const wxUniChar& c);
int wxIsctrl(const wxUniChar& c);
//@}
///@}

4
interface/wx/xlocale.h
View file

@ -104,7 +104,7 @@ wxXLocale wxNullXLocale;
// ============================================================================
/** @addtogroup group_funcmacro_locale */
//@{
///@{
int wxIsalnum_l(wchar_t c, const wxXLocale& loc);
int wxIsalpha_l(wchar_t c, const wxXLocale& loc);
@ -124,5 +124,5 @@ double wxStrtod_l(const wchar_t *c, wchar_t **endptr, const wxXLocale& loc);
long wxStrtol_l(const wchar_t *c, wchar_t **endptr, int base, const wxXLocale& loc);
unsigned long wxStrtoul_l(const wchar_t *c, wchar_t **endptr, int base, const wxXLocale& loc);
//@}
///@}