X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3051a44a73502c2b03d1618d0a8e94274ee67e16..5f519da23d582da30a0d7894d330198c673400d6:/docs/doxygen/Doxyfile_inc
diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc
index 2a695611ef..f7d9aed5cb 100644
--- a/docs/doxygen/Doxyfile_inc
+++ b/docs/doxygen/Doxyfile_inc
@@ -3,7 +3,7 @@
## Purpose: Main configuration file for the wxWidgets manual
## Author: Francesco Montorsi
## RCS-ID: $Id$
-## Licence: wxWindows license
+## Licence: wxWindows licence
#############################################################################
#---------------------------------------------------------------------------
@@ -12,7 +12,9 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = wxWidgets
-PROJECT_NUMBER = 2.9.0
+PROJECT_NUMBER = 2.9.4
+PROJECT_BRIEF =
+PROJECT_LOGO = logo.png
OUTPUT_DIRECTORY = out
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
@@ -83,7 +85,21 @@ ALIASES += flag{1}="\li \1:
Appearance: | | |
wxMSW appearance | wxGTK appearance | wxMac appearance |
\endhtmlonly"
+# that look different in different ports. genericAppearance can be used for the
+# controls that always look the same.
+ALIASES += appearance{1}="\htmlonly
Appearance: | | |
wxMSW appearance | wxGTK appearance | wxMac appearance |
\endhtmlonly"
+ALIASES += genericAppearance{1}="\htmlonly
\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
@@ -92,6 +108,7 @@ ALIASES += appearance{1}="\htmlonly
Appearance
# 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 += 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:"
@@ -191,8 +208,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/\1"
# For refering to the corresponding sample in a class document or a overview
# Usually placed in the queue of @see
@@ -306,30 +323,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
+
+#---------------------------------------------------------------------------
+# 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
@@ -440,7 +482,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
@@ -449,6 +490,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
#---------------------------------------------------------------------------