## Purpose: Main configuration file for the wxWidgets manual
## Author: Francesco Montorsi
## RCS-ID: $Id$
-## Licence: wxWindows license
+## Licence: wxWindows licence
#############################################################################
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = wxWidgets
-PROJECT_NUMBER = 2.9.0
+PROJECT_NUMBER = 2.9.5
+PROJECT_BRIEF =
+PROJECT_LOGO = logo.png
OUTPUT_DIRECTORY = out
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
ALIASES += endFlagTable="</div>\n"
# creates appearance section: this should be used for all main GUI controls
-ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
+# that look different in different ports. genericAppearance can be used for the
+# controls that always look the same.
+ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'/></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'/></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'/></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
+ALIASES += genericAppearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='generic/\1' alt='Generic appearance' class='appearance'/></td></tr></table></div> \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}="<a name='\1'></a> \name \2"
+ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
+
#---------------------------------------------------------------------------
# Aliases - for use when documenting any C++ entity
# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
+ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
# See ENABLED_SECTIONS configuration key for more info about these:
ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
ALIASES += endWxPerlOnly="\endif"
-ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
-ALIASES += endWxPythonOnly="\endif"
# This is to get around a bug in Doxygen that prevents use of '{' or '}'
# inside of any aliased command in parameters.
# 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
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
+
+#---------------------------------------------------------------------------
+# 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
+
+#---------------------------------------------------------------------------
+# 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
GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = png
-DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
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
#---------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff