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:"
@@ -76,7 +85,21 @@ ALIASES += flag{1}="
\li \1:\n"
# creates appearance section: this should be used for all main GUI controls
-ALIASES += appearance{1}="\htmlonly
Appearance:
\endhtmlonly"
+# that look different in different ports. genericAppearance can be used for the
+# controls that always look the same.
+ALIASES += appearance{1}="\htmlonly | wxMSW appearance | wxGTK appearance | wxMac appearance |
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
@@ -85,6 +108,7 @@ ALIASES += appearance{1}="\htmlonly Appearance
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n\1 @image ht
# See ENABLED_SECTIONS configuration key for more info about these:
ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: "
ALIASES += endWxPerlOnly="\endif"
-ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL wxPython Note: "
-ALIASES += endWxPythonOnly="\endif"
# This is to get around a bug in Doxygen that prevents use of '{' or '}'
# inside of any aliased command in parameters.
@@ -184,8 +206,8 @@ ALIASES += rightCurly="}"
# Aliases - for use when documenting samples
#---------------------------------------------------------------------------
-# For indicating the a directory containing a sample
-ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
+# For indicating a sample location
+ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"
# For refering to the corresponding sample in a class document or a overview
# Usually placed in the queue of @see
@@ -299,30 +321,55 @@ IGNORE_PREFIX = wx
GENERATE_HTML = NO # Only change in format output configs
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
-HTML_HEADER = htmlheader.inc
-HTML_FOOTER = htmlfooter.inc
-HTML_STYLESHEET =
+HTML_HEADER = custom_header.html
+HTML_FOOTER = custom_footer.html
+HTML_STYLESHEET = custom_stylesheet.css
+HTML_EXTRA_FILES = jquery-1.3.2.min.js
+HTML_COLORSTYLE_HUE =
+HTML_COLORSTYLE_SAT = 255
+HTML_COLORSTYLE_GAMMA = 100
+HTML_TIMESTAMP = YES
HTML_ALIGN_MEMBERS = YES
HTML_DYNAMIC_SECTIONS = YES
-GENERATE_DOCSET = NO # Only change in format output configs
-DOCSET_FEEDNAME = "wxWidgets"
-DOCSET_BUNDLE_ID = org.wxwidgets.doxygen
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 1
+GENERATE_TREEVIEW = NO
+USE_INLINE_TREES = NO
+TREEVIEW_WIDTH = 250
+EXT_LINKS_IN_WINDOW = YES
+FORMULA_FONTSIZE = 10
+FORMULA_TRANSPARENT = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the CHM output
+#---------------------------------------------------------------------------
+
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 =
+
+#---------------------------------------------------------------------------
+# configuration options related to the Qt Help Project output
+#---------------------------------------------------------------------------
+
+GENERATE_QHP = NO # Only change in format output configs
+QCH_FILE =
QHP_NAMESPACE = org.wxwidgets.doxygen
QHP_VIRTUAL_FOLDER = doc
-QHG_LOCATION =
-DISABLE_INDEX = NO
-ENUM_VALUES_PER_LINE = 1
-GENERATE_TREEVIEW = NONE
-TREEVIEW_WIDTH = 250
-FORMULA_FONTSIZE = 10
+QHG_LOCATION =
+
+#---------------------------------------------------------------------------
+# configuration options related to the Docset output
+#---------------------------------------------------------------------------
+
+GENERATE_DOCSET = NO # Only change in format output configs
+DOCSET_FEEDNAME = "wxWidgets 2.9"
+DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29
+DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
+DOCSET_PUBLISHER_NAME = wxWidgets Team
#---------------------------------------------------------------------------
# LaTeX Output Options
@@ -420,7 +467,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 +480,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 +488,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
#---------------------------------------------------------------------------
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:"
@@ -172,8 +196,6 @@ ALIASES += stock{3}="