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:"
@@ -56,12 +69,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
@@ -69,11 +82,30 @@ ALIASES += beginFlagTable=""
ALIASES += flag{1}="
\li \1:"
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
+#---------------------------------------------------------------------------
+
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n| wxMSW appearance | wxGTK appearance | wxMac appearance |
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 += 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:
@@ -90,9 +122,6 @@ 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
\1 \2,\3,\4
ALIASES += itemdef{9}=" \1 \2,\3,\4,\5,\6,\7,\8,\9 \1 \2,\3,\4,\5,\6,\7,\8,\9,\10 \1 @image html gtk-\2.png\n \3 for more info."
@@ -199,7 +240,8 @@ HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
-SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
+SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
+SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
@@ -212,8 +254,10 @@ ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO
SHOW_DIRECTORIES = YES
-#SHOW_FILES = YES # Doxygen 1.5.6+ only
+SHOW_FILES = YES
+SHOW_NAMESPACES = NO
FILE_VERSION_FILTER =
+LAYOUT_FILE = DoxygenLayout.xml
#---------------------------------------------------------------------------
# Warning and Progress Message Options
@@ -278,17 +322,26 @@ HTML_HEADER = htmlheader.inc
HTML_FOOTER = htmlfooter.inc
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
-GENERATE_HTMLHELP = NO # Only change in format output configs
HTML_DYNAMIC_SECTIONS = YES
+GENERATE_DOCSET = NO # Only change in format output configs
+DOCSET_FEEDNAME = "wxWidgets"
+DOCSET_BUNDLE_ID = org.wxwidgets.doxygen
+GENERATE_HTMLHELP = NO # Only change in format output configs
CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
+GENERATE_QHP = NO
+QCH_FILE =
+QHP_NAMESPACE = org.wxwidgets.doxygen
+QHP_VIRTUAL_FOLDER = doc
+QHG_LOCATION =
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 1
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = NONE
TREEVIEW_WIDTH = 250
+FORMULA_FONTSIZE = 10
#---------------------------------------------------------------------------
# LaTeX Output Options
@@ -384,7 +437,10 @@ CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
-CLASS_GRAPH = NO
+DOT_FONTNAME = FreeSans
+DOT_FONTSIZE = 10
+DOT_FONTPATH =
+CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = NO
@@ -396,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
@@ -405,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
#---------------------------------------------------------------------------
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"
-
# 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"
@@ -101,6 +130,7 @@ ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
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
@@ -152,6 +182,11 @@ ALIASES += itemdef{8}="| wxMSW appearance | wxGTK appearance | wxMac appearance |