3a6c62a965
In newer doxygen versions, the label was being used as the caption for the image and not appearing in the 3rd column. The only way to really fix this seems to be to make the image the last column so that it doesn't eat the remaining text (there is no way to escape it apparently).
589 lines
27 KiB
Plaintext
589 lines
27 KiB
Plaintext
# Doxyfile 1.8.8
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = wxWidgets
|
|
PROJECT_NUMBER = 3.1.6
|
|
PROJECT_BRIEF =
|
|
PROJECT_LOGO = logo.png
|
|
OUTPUT_DIRECTORY = out
|
|
CREATE_SUBDIRS = NO
|
|
ALLOW_UNICODE_NAMES = NO
|
|
OUTPUT_LANGUAGE = English
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF =
|
|
ALWAYS_DETAILED_SEC = YES # Default: NO
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = ../..
|
|
STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
|
|
"$(WXWIDGETS)/interface/"
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES # Default: NO
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
TCL_SUBST =
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
OPTIMIZE_FOR_FORTRAN = NO
|
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
EXTENSION_MAPPING =
|
|
MARKDOWN_SUPPORT = YES
|
|
AUTOLINK_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = NO
|
|
CPP_CLI_SUPPORT = NO
|
|
SIP_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = NO # Default: YES
|
|
DISTRIBUTE_GROUP_DOC = YES # Default: NO
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO # TODO: Examine this setting.
|
|
INLINE_SIMPLE_STRUCTS = NO # TODO: Examine this setting.
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
LOOKUP_CACHE_SIZE = 0
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Aliases
|
|
#---------------------------------------------------------------------------
|
|
|
|
# This is the most important part of the wxWidgets Doxyfile. Aliases allow
|
|
# us to keep the headers readable and "implement" wxWidgets-specific commands.
|
|
|
|
# Aliases for documenting C++ classes
|
|
#---------------------------------------------------------------------------
|
|
|
|
# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
|
|
ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
|
|
ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span></div></p>Event macros for events emitted by this class:<div>"
|
|
ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros for events emitted by this class:<div>"
|
|
|
|
# aliases to be used in wxEvent-derived classes:
|
|
ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span></div></p>Event macros:<div>"
|
|
ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros:<div>"
|
|
|
|
# common event aliases:
|
|
ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
|
|
ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
|
|
ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
|
|
ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
|
|
ALIASES += endEventTable="</div>\n"
|
|
|
|
# style aliases
|
|
ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
|
|
ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
|
|
ALIASES += endStyleTable="</div>\n"
|
|
|
|
# extra style aliases
|
|
ALIASES += beginExtraStyleTable="\n<hr><h2>Extra Styles</h2><p>This class supports the following extra styles:</p><div>"
|
|
ALIASES += endExtraStyleTable="</div>\n"
|
|
|
|
# flag aliases
|
|
ALIASES += beginFlagTable="<div>"
|
|
ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
|
|
ALIASES += endFlagTable="</div>\n"
|
|
|
|
# creates appearance section: this should be used for all main GUI controls
|
|
# that look different in different ports. genericAppearance can be used for the
|
|
# controls that always look the same.
|
|
ALIASES += appearance{1}="\htmlonly<div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td>\endhtmlonly\n\image html appear-\1-msw.png \"wxMSW Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-gtk.png \"wxGTK Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-mac.png \"wxOSX Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
|
|
ALIASES += genericAppearance{1}="\htmlonly<div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td>\endhtmlonly\n\image html generic/\1.png \"Generic Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
|
|
|
|
# these compact versions are only used on the screenshots page
|
|
ALIASES += appearance_brief{2}="\htmlonly<div class='appearance_brief'><table><tr><td>\endhtmlonly\n\1\htmlonly</td><td>\endhtmlonly\n\image html appear-\2-msw.png\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\2-gtk.png\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\2-mac.png\n\htmlonly</td></tr></table></div>\endhtmlonly"
|
|
ALIASES += genericAppearance_brief{2}="\htmlonly<div class='appearance_brief'><table><tr><td>\endhtmlonly\n\1\htmlonly</td><td>\endhtmlonly\n\image html generic/\2.png\n\htmlonly</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 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>"
|
|
|
|
# native implementation infos:
|
|
ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
|
|
ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
|
|
ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
|
|
ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
|
|
|
|
# onlyfor infos:
|
|
# NOTE: we need to be able to retrieve these infos also from the XML output, thus
|
|
# we use the \xmlonly and \endxmlonly commands to include custom XML tags
|
|
ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
|
|
ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
|
|
ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
|
|
ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
|
|
|
|
# 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"
|
|
|
|
# some formatting aliases
|
|
ALIASES += true="<span class='literal'>true</span>"
|
|
ALIASES += false="<span class='literal'>false</span>"
|
|
ALIASES += NULL="<span class='literal'>NULL</span>"
|
|
ALIASES += NUL="<span class='literal'>NUL</span>"
|
|
|
|
# NOTE: these are important as you can't write in the docs
|
|
# just #ifdef since the # character is used by Doxygen
|
|
# for explicit linking; use the following aliases instead!
|
|
# However to avoid overwriting e.g. \if Doxygen command the _
|
|
# character is postfixed
|
|
ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
|
|
ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
|
|
ALIASES += if_="<span class='literal'>\#if</span>"
|
|
ALIASES += endif_="<span class='literal'>\#endif</span>"
|
|
|
|
# table aliases for 2 and 3 column tables
|
|
ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
|
|
ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
|
|
ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
|
|
ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
|
|
ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
|
|
ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
|
|
ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
|
|
ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
|
|
ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
|
|
ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
|
|
ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
|
|
ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
|
|
ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
|
|
ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
|
|
ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
|
|
ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
|
|
ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
|
|
ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
|
|
ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
|
|
ALIASES += row3col{11}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11</td></tr>"
|
|
ALIASES += row3col{12}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12</td></tr>"
|
|
ALIASES += row3col{13}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13</td></tr>"
|
|
ALIASES += row3col{14}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14</td></tr>"
|
|
ALIASES += row3col{15}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14,\15</td></tr>"
|
|
ALIASES += row3col{16}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14,\15,\16</td></tr>"
|
|
ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
|
|
ALIASES += endTable="</table>"
|
|
|
|
# definition list aliases
|
|
# a definition list currently is rendered as 2-column table but it may use as
|
|
# well the <dl>, <dt> and <dd> HTML tags in future.
|
|
# In any case a definition list differs from a table because of its semantic
|
|
# nature and because it is always the association of a "title" with a "description"
|
|
# (in contrast a table may have more than 2 columns of data)...
|
|
ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
|
|
ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
|
|
ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
|
|
ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
|
|
ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
|
|
ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
|
|
ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
|
|
ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
|
|
ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
|
|
ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
|
|
ALIASES += endDefList="</table>"
|
|
ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td> <td> @image html gtk-\3.png </td></tr>"
|
|
|
|
# Aliases for documenting wxPerl/wxPython-specific parts
|
|
#---------------------------------------------------------------------------
|
|
|
|
# See ENABLED_SECTIONS configuration key for more info about these:
|
|
ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
|
|
ALIASES += endWxPerlOnly="\endif"
|
|
|
|
# This is to get around a bug in Doxygen that prevents use of '{' or '}'
|
|
# inside of any aliased command in parameters.
|
|
ALIASES += leftCurly="{"
|
|
ALIASES += rightCurly="}"
|
|
|
|
# Aliases for documenting samples
|
|
#---------------------------------------------------------------------------
|
|
|
|
# For indicating a sample location
|
|
ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or https://github.com/wxWidgets/wxWidgets/tree/master/samples/\1"
|
|
|
|
# For referring to the corresponding sample in a class document or a overview
|
|
# Usually placed in the queue of @see
|
|
ALIASES += sample{1}="\ref page_samples_\1"
|
|
|
|
# For generating a general description for a sample
|
|
# \1 could be a class or an overview or a descriptive sentence
|
|
# Shall be replaced by manual written description soon
|
|
ALIASES += sampleabout{1}="This sample demonstrates \1."
|
|
|
|
# For indicating the necessary condition of a sample or a class
|
|
# \1 is the wxUSE_XXX macro
|
|
ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
|
|
ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Build Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
EXTRACT_ALL = YES # Default: NO
|
|
EXTRACT_PRIVATE = YES # Default: NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES # Default: NO
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = YES # TODO: Default: NO
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = NO
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = NO
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = NO # Default: YES
|
|
HIDE_SCOPE_NAMES = NO
|
|
SHOW_INCLUDE_FILES = YES
|
|
SHOW_GROUPED_MEMB_INC = NO # TODO: YES
|
|
FORCE_LOCAL_INCLUDES = NO
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
|
|
SORT_MEMBERS_CTORS_1ST = NO # Default: NO
|
|
SORT_GROUP_NAMES = YES # Default: NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = YES
|
|
GENERATE_TESTLIST = YES
|
|
GENERATE_BUGLIST = YES
|
|
GENERATE_DEPRECATEDLIST= YES
|
|
ENABLED_SECTIONS = WXPERL_MANUAL \
|
|
WXPYTHON_MANUAL
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = NO # Default: YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = NO # TODO: Default: YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE = DoxygenLayout.xml
|
|
CITE_BIB_FILES =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Warning and Progress Message Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
QUIET = YES # Default: NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = YES # Default: NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE = doxygen.log
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Input File Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
INPUT = mainpages \
|
|
groups \
|
|
overviews \
|
|
../gtk \
|
|
../ios \
|
|
../motif \
|
|
../msw \
|
|
../osx \
|
|
../qt \
|
|
../x11 \
|
|
../../interface
|
|
INPUT_ENCODING = UTF-8
|
|
FILE_PATTERNS = *.h *.md
|
|
RECURSIVE = YES # Default: NO
|
|
EXCLUDE =
|
|
EXCLUDE_SYMLINKS = NO
|
|
EXCLUDE_PATTERNS =
|
|
EXCLUDE_SYMBOLS =
|
|
EXAMPLE_PATH = ../
|
|
EXAMPLE_PATTERNS = *
|
|
EXAMPLE_RECURSIVE = NO
|
|
IMAGE_PATH = images
|
|
INPUT_FILTER =
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
USE_MDFILE_AS_MAINPAGE =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Source Browsing Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
SOURCE_BROWSER = NO
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = NO
|
|
REFERENCES_RELATION = NO
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = NO # Default: YES
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Alphabetical Class Index Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX = wx
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# HTML Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_HTML = $(GENERATE_HTML)
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER = custom_header.html
|
|
HTML_FOOTER = custom_footer.html
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_STYLESHEET = extra_stylesheet.css
|
|
HTML_EXTRA_FILES = wxwidgets.js
|
|
HTML_COLORSTYLE_HUE = 220 # Default: 220
|
|
HTML_COLORSTYLE_SAT = 255 # Default: 100
|
|
HTML_COLORSTYLE_GAMMA = 100 # Default: 80
|
|
HTML_TIMESTAMP = YES
|
|
HTML_DYNAMIC_SECTIONS = YES # Default: NO
|
|
HTML_INDEX_NUM_ENTRIES = 100
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Docset Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_DOCSET = $(GENERATE_DOCSET)
|
|
DOCSET_FEEDNAME = "wxWidgets 3.1"
|
|
DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx31
|
|
DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
|
|
DOCSET_PUBLISHER_NAME = wxWidgets
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# CHM Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_HTMLHELP = $(GENERATE_HTMLHELP)
|
|
CHM_FILE = ..\wx.chm # Windows style separator is required.
|
|
HHC_LOCATION = hhc.exe
|
|
GENERATE_CHI = NO
|
|
CHM_INDEX_ENCODING =
|
|
BINARY_TOC = NO
|
|
TOC_EXPAND = NO
|
|
TOC_INCLUDE_HEADINGS = 3
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# QHP Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_QHP = $(GENERATE_QHP)
|
|
QCH_FILE =
|
|
QHP_NAMESPACE = org.wxwidgets.doxygen
|
|
QHP_VIRTUAL_FOLDER = doc
|
|
QHP_CUST_FILTER_NAME =
|
|
QHP_CUST_FILTER_ATTRS =
|
|
QHP_SECT_FILTER_ATTRS =
|
|
QHG_LOCATION =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Eclipse Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_ECLIPSEHELP = NO
|
|
ECLIPSE_DOC_ID = org.wxwidgets.doxygen
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Other Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = NO
|
|
ENUM_VALUES_PER_LINE = 1 # Default: 4
|
|
TREEVIEW_WIDTH = 250
|
|
EXT_LINKS_IN_WINDOW = YES # Default: NO
|
|
FORMULA_FONTSIZE = 10
|
|
FORMULA_TRANSPARENT = YES
|
|
USE_MATHJAX = NO
|
|
MATHJAX_FORMAT = HTML-CSS
|
|
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
|
MATHJAX_EXTENSIONS =
|
|
MATHJAX_CODEFILE =
|
|
SEARCHENGINE = $(SEARCHENGINE)
|
|
SERVER_BASED_SEARCH = $(SERVER_BASED_SEARCH)
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
SEARCHDATA_FILE = searchdata.xml
|
|
EXTERNAL_SEARCH_ID =
|
|
EXTRA_SEARCH_MAPPINGS =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# LaTeX Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_LATEX = $(GENERATE_LATEX)
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
COMPACT_LATEX = NO
|
|
PAPER_TYPE = a4
|
|
EXTRA_PACKAGES =
|
|
LATEX_HEADER = latex_header.tex
|
|
LATEX_FOOTER =
|
|
LATEX_EXTRA_FILES =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = YES # Default: NO
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_SOURCE_CODE = NO
|
|
LATEX_BIB_STYLE = plain
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# RTF Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_RTF = NO
|
|
RTF_OUTPUT = rtf
|
|
COMPACT_RTF = NO
|
|
RTF_HYPERLINKS = NO
|
|
RTF_STYLESHEET_FILE =
|
|
RTF_EXTENSIONS_FILE =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Man Page Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_MAN = NO
|
|
MAN_OUTPUT = man
|
|
MAN_EXTENSION = .3
|
|
MAN_SUBDIR =
|
|
MAN_LINKS = NO
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# XML Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_XML = $(GENERATE_XML)
|
|
XML_OUTPUT = xml
|
|
XML_PROGRAMLISTING = NO # Default: YES
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# DOCBOOK Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_DOCBOOK = NO
|
|
DOCBOOK_OUTPUT = docbook
|
|
DOCBOOK_PROGRAMLISTING = NO
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# AutoGen Definitions Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Perl Module Output Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
GENERATE_PERLMOD = NO
|
|
PERLMOD_LATEX = YES # Default: NO
|
|
PERLMOD_PRETTY = YES
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Preprocessor Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = NO
|
|
EXPAND_ONLY_PREDEF = NO
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH =
|
|
INCLUDE_FILE_PATTERNS =
|
|
PREDEFINED = wxUSE_BASE \
|
|
wxUSE_GUI
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Additions Related to External References
|
|
#---------------------------------------------------------------------------
|
|
|
|
TAGFILES =
|
|
GENERATE_TAGFILE = $(GENERATE_TAGFILE)
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
PERL_PATH = /usr/bin/perl
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
# dot Tool Options
|
|
#---------------------------------------------------------------------------
|
|
|
|
CLASS_DIAGRAMS = YES
|
|
MSCGEN_PATH =
|
|
DIA_PATH =
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
HAVE_DOT = YES # Default: NO
|
|
DOT_NUM_THREADS = 0
|
|
DOT_FONTNAME =
|
|
DOT_FONTSIZE = 10
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = YES
|
|
COLLABORATION_GRAPH = NO # Default: YES
|
|
GROUP_GRAPHS = NO # Default: YES
|
|
UML_LOOK = NO
|
|
UML_LIMIT_NUM_FIELDS = 10
|
|
TEMPLATE_RELATIONS = NO
|
|
INCLUDE_GRAPH = NO # Default: YES
|
|
INCLUDED_BY_GRAPH = NO # Default: YES
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = NO # TODO: Default: YES
|
|
DIRECTORY_GRAPH = NO # Default: YES
|
|
DOT_IMAGE_FORMAT = png
|
|
INTERACTIVE_SVG = NO
|
|
DOT_PATH =
|
|
DOTFILE_DIRS =
|
|
MSCFILE_DIRS =
|
|
DIAFILE_DIRS =
|
|
PLANTUML_JAR_PATH =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 1000 # Default: 0
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|