Events
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:"
+# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
+ALIASES = beginEventEmissionTable="\n
Events emitted by this class
Event macros for events emitted by this class:
"
+ALIASES += beginEventEmissionTable{1}="\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)
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:"
+
+# common event aliases:
ALIASES += event{1}="
\li \1:"
ALIASES += event{2}="
\li \1, \2:"
ALIASES += event{3}="
\li \1, \2, \3:"
@@ -78,6 +85,17 @@ ALIASES += endFlagTable="
\n"
# creates appearance section: this should be used for all main GUI controls
ALIASES += appearance{1}="\htmlonly 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
#---------------------------------------------------------------------------
@@ -85,6 +103,7 @@ ALIASES += appearance{1}="\htmlonly | wxMSW appearance | wxGTK appearance | wxMac appearance |
Appearance
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n
Category: \ref group_class_\1
"
ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \nCategory: \ref group_class_\1, \ref group_class_\2
"
+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:"
@@ -314,10 +333,10 @@ GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
GENERATE_QHP = NO
-QCH_FILE =
+QCH_FILE =
QHP_NAMESPACE = org.wxwidgets.doxygen
QHP_VIRTUAL_FOLDER = doc
-QHG_LOCATION =
+QHG_LOCATION =
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NONE
@@ -420,7 +439,7 @@ HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
DOT_FONTNAME = FreeSans
DOT_FONTSIZE = 10
-DOT_FONTPATH =
+DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
@@ -433,7 +452,6 @@ CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = png
-DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
@@ -442,6 +460,12 @@ DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
+# instead of setting a value for DOT_PATH it's easier and more portable to
+# put your dot utility in the PATH; if you are on a Unix system this is usually
+# done automatically; if you're on Windows you'll need to install GraphViz tools
+# and then manually add it to the PATH environment variable
+DOT_PATH =
+
#---------------------------------------------------------------------------
# Search Engine Options
#---------------------------------------------------------------------------