Events emitted by this class
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(\1& event)
Event macros for events emitted by this class:"
+ALIASES += beginEventEmissionTable{2}="\n
Events emitted by this class
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(\1& event) or void handlerFuncName(\2& event)
Event macros for events emitted by this class:"
+
+# aliases to be used in wxEvent-derived classes:
+ALIASES += beginEventTable{1}="\n
Events using this class
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(\1& event)
Event macros:"
+ALIASES += beginEventTable{2}="\n
Events using this class
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(\1& event) or void handlerFuncName(\2& event)
Event macros:"
-# event aliases
-ALIASES = beginEventTable{1}="\nEvents:
Event macros:
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
void handlerFuncName(\1& event)
Event macros:
"
+# common event aliases:
ALIASES += event{1}="
\li \1:"
ALIASES += event{2}="
\li \1, \2:"
ALIASES += event{3}="
\li \1, \2, \3:"
@@ -55,12 +71,12 @@ ALIASES += event{4}="
\li \1, \2, \3, \4:\n"
# style aliases
-ALIASES += beginStyleTable="\nStyles:
"
+ALIASES += beginStyleTable="\n
Styles
This class supports the following styles:
"
ALIASES += style{1}="
\li \1:"
ALIASES += endStyleTable="
\n"
# extra style aliases
-ALIASES += beginExtraStyleTable="\nExtra styles:"
+ALIASES += beginExtraStyleTable="\n
Extra styles
This class supports the following extra styles:
"
ALIASES += endExtraStyleTable="
\n"
# flag aliases
@@ -68,11 +84,33 @@ ALIASES += beginFlagTable=""
ALIASES += flag{1}="
\li \1:"
ALIASES += endFlagTable="
\n"
+# creates appearance section: this should be used for all main GUI controls
+# that look different in different ports. genericAppearance can be used for the
+# controls that always look the same.
+ALIASES += appearance{1}="\htmlonly Appearance:
\endhtmlonly"
+ALIASES += genericAppearance{1}="\htmlonly | wxMSW appearance | wxGTK appearance | wxMac appearance |
Appearance:
\endhtmlonly"
+
+# aliases for the creation of "named member groups"
+# USAGE: the first argument must not contain spaces and be a unique identifier
+# of the member group for the class being documented;
+# the second argument is the member group name and can contain spaces
+# See wxString as an usage example.
+# NOTE: no warnings are given for wrong member group names so be careful and check
+# the doxygen output to verify that there are no typos
+ALIASES += member_group_name{2}=" \name \2"
+ALIASES += ref_member_group{2}="\2"
+
+
+#---------------------------------------------------------------------------
+# Aliases - for use when documenting any C++ entity
+#---------------------------------------------------------------------------
+
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \nCategory: \ref group_class_\1
"
ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \nCategory: \ref group_class_\1, \ref group_class_\2
"
-ALIASES += library{1}="Library: \ref page_libs_\1
"
-ALIASES += nolibrary="Library: None; this class implementation is entirely header-based.
"
+ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \nCategory: \ref group_class_\1, \ref group_class_\2, \ref group_class_\3
"
+ALIASES += library{1}="Library: \ref page_libs_\1
"
+ALIASES += nolibrary="Library: None; this class implementation is entirely header-based.
"
ALIASES += stdobjects="Predefined objects/pointers:"
# native implementation infos:
@@ -89,25 +127,15 @@ ALIASES += onlyfor{2}="Availability:
ALIASES += onlyfor{3}="\1,\2,\3 \endxmlonly"
ALIASES += onlyfor{4}="\1,\2,\3,\4 \endxmlonly"
-# creates appearance section: this should be used for all main GUI controls
-ALIASES += appearance{1}="@htmlonly
"
-ALIASES += beginInvisibleTable="
Availability: only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.
\xmlonly Availability: only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.
\xmlonly Appearance:
@endhtmlonly"
-
-# IMPORTANT: the \headerfile command does not work everywhere we'd need it,
-# e.g. in the constants page we need to specify an header file
-# even if they're not inside a \class, \function or \struct command:
+# Use this in grouped global functions, and macros since they
+# wouldn't otherwise indicate what header they are defined in.
ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
-# IMPORTANT: inside a \class, we want to specify the header file only once
-# and not twice as the \headerfile command requires:
-ALIASES += wxheader{1}="\headerfile \1 wx/\1"
-
-# the following alias avoids to repeat lots of times the same statement:
-ALIASES += wxsince{1}="\since This feature is available in wxWidgets version \1 or higher."
-
# some formatting aliases
ALIASES += true="true"
ALIASES += false="false"
ALIASES += NULL="NULL"
+ALIASES += NUL="NUL"
# NOTE: these are important as you can't write in the docs
# just #ifdef since the # character is used by Doxygen
@@ -120,8 +148,8 @@ ALIASES += if_="\#if"
ALIASES += endif_="\#endif"
# table aliases for 2 and 3 column tables
-ALIASES += beginTable="| wxMSW appearance | wxGTK appearance | wxMac appearance |
| \1 | \2 | |
| \1 | \2,\3 | |
| \1 | \2,\3,\4 | |
| \1 | \2 | \3,\4,\5,\6,\7 |
| \1 | \2 | \3,\4,\5,\6,\7,\8 |
| \1 | \2 | \3,\4,\5,\6,\7,\8,\9 |
| \1 | \2 | \3,\4,\5,\6,\7,\8,\9,\10 |