# Doxyfile 1.8.2 #--------------------------------------------------------------------------- # Project Options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = wxWidgets PROJECT_NUMBER = 2.9.5 PROJECT_BRIEF = PROJECT_LOGO = logo.png OUTPUT_DIRECTORY = out CREATE_SUBDIRS = 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 = "$(WXWIDGETS)/" 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 SYMBOL_CACHE_SIZE = 0 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

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:
" ALIASES += event{4}="
\li \1, \2, \3, \4:
" ALIASES += endEventTable="
\n" # style aliases ALIASES += beginStyleTable="\n

Styles

This class supports the following styles:

" ALIASES += style{1}="
\li \1:
" ALIASES += endStyleTable="
\n" # extra style aliases ALIASES += beginExtraStyleTable="\n

Extra Styles

This class supports the following extra styles:

" ALIASES += endExtraStyleTable="
\n" # flag aliases ALIASES += beginFlagTable="
" ALIASES += flag{1}="
\li \1:
" ALIASES += endFlagTable="
\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
Appearance:
\endhtmlonly\n\image html wxmsw/\1 \"wxMSW Appearance\"\n\htmlonly\endhtmlonly\n\image html wxgtk/\1 \"wxGTK Appearance\"\n\htmlonly\endhtmlonly\n\image html wxmac/\1 \"wxOSX Appearance\"\n\htmlonly
\endhtmlonly" ALIASES += genericAppearance{1}="\htmlonly
Appearance:
\endhtmlonly\n\image html generic/\1 \"Generic Appearance\"\n\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 documenting any C++ entity #--------------------------------------------------------------------------- # aliases for additional wx-specific infos ALIASES += category{1}="\ingroup group_class_\1 \n
Category:  \ref group_class_\1
" ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n
Category:  \ref group_class_\1, \ref group_class_\2
" ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n
Category:  \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: ALIASES += nativeimpl{1}="
Implementations:  native under \ref page_port_\1 port; a generic implementation is used elsewhere.
" ALIASES += nativeimpl{2}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.
" ALIASES += nativeimpl{3}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.
" ALIASES += nativeimpl{4}="
Implementations:  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.
" # 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}="
Availability:  only available for the \ref page_port_\1 port.
\xmlonly \1 \endxmlonly" ALIASES += onlyfor{2}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2 ports.
\xmlonly \1,\2 \endxmlonly" ALIASES += onlyfor{3}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.
\xmlonly \1,\2,\3 \endxmlonly" ALIASES += onlyfor{4}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.
\xmlonly \1,\2,\3,\4 \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="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 # for explicit linking; use the following aliases instead! # However to avoid overwriting e.g. \if Doxygen command the _ # character is postfixed ALIASES += ifdef_="\#ifdef" ALIASES += ifndef_="\#ifndef" ALIASES += if_="\#if" ALIASES += endif_="\#endif" # table aliases for 2 and 3 column tables ALIASES += beginTable="" ALIASES += beginInvisibleTable="
" ALIASES += row2col{2}="" ALIASES += row2col{3}="" ALIASES += row2col{4}="" ALIASES += row2col{5}="" ALIASES += row2col{6}="" ALIASES += row2col{7}="" ALIASES += row2col{8}="" ALIASES += row2col{9}="" ALIASES += row2col{10}="" ALIASES += row3col{3}="" ALIASES += row3col{4}="" ALIASES += row3col{5}="" ALIASES += row3col{6}="" ALIASES += row3col{7}="" ALIASES += row3col{8}="" ALIASES += row3col{9}="" ALIASES += row3col{10}="" ALIASES += hdr3col{3}="" ALIASES += endTable="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\4,\5
\1 \2,\3,\4,\5,\6
\1 \2,\3,\4,\5,\6,\7
\1 \2,\3,\4,\5,\6,\7,\8
\1 \2,\3,\4,\5,\6,\7,\8,\9
\1 \2,\3,\4,\5,\6,\7,\8,\9,\10
\1 \2 \3
\1 \2 \3,\4
\1 \2 \3,\4,\5
\1 \2 \3,\4,\5,\6
\1 \2 \3,\4,\5,\6,\7
\1 \2 \3,\4,\5,\6,\7,\8
\1 \2 \3,\4,\5,\6,\7,\8,\9
\1 \2 \3,\4,\5,\6,\7,\8,\9,\10
\1 \2 \3
" # definition list aliases # a definition list currently is rendered as 2-column table but it may use as # well the
,
and
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="" ALIASES += itemdef{2}="" ALIASES += itemdef{3}="" ALIASES += itemdef{4}="" ALIASES += itemdef{5}="" ALIASES += itemdef{6}="" ALIASES += itemdef{7}="" ALIASES += itemdef{8}="" ALIASES += itemdef{9}="" ALIASES += itemdef{10}="" ALIASES += endDefList="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\4,\5
\1 \2,\3,\4,\5,\6
\1 \2,\3,\4,\5,\6,\7
\1 \2,\3,\4,\5,\6,\7,\8
\1 \2,\3,\4,\5,\6,\7,\8,\9
\1 \2,\3,\4,\5,\6,\7,\8,\9,\10
" ALIASES += stock{3}="\1 @image html gtk-\2.png\n\3" # Aliases for documenting wxPerl/wxPython-specific parts #--------------------------------------------------------------------------- # See ENABLED_SECTIONS configuration key for more info about these: ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: " 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 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 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}="Build Note: You may need to build the wxWidgets library with \1 being set to 1 to be able to make it work, please read comments in @c for more info." ALIASES += buildwith{2}="Build Note: You may need to build the wxWidgets library with \1 and \2 being set to 1 to be able to make it work, please read comments in @c for more info." #--------------------------------------------------------------------------- # Build Options #--------------------------------------------------------------------------- EXTRACT_ALL = YES # Default: NO EXTRACT_PRIVATE = 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 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 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords 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 ../../interface INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h 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 = #--------------------------------------------------------------------------- # Source Browsing Options #--------------------------------------------------------------------------- SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = NO REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = 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 = YES # Only re-enable in format-specific config files. 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 = 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 DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 1 # Default: 4 GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = YES # Default: NO FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES USE_MATHJAX = NO MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = SEARCHENGINE = YES SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # Docset Output Options #--------------------------------------------------------------------------- GENERATE_DOCSET = NO # Only re-enable in format-specific config files. DOCSET_FEEDNAME = "wxWidgets 2.9" DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29 DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen DOCSET_PUBLISHER_NAME = wxWidgets Team #--------------------------------------------------------------------------- # CHM Output Options #--------------------------------------------------------------------------- GENERATE_HTMLHELP = NO # Only re-enable in format-specific config files. CHM_FILE = ..\wx.chm # Windows style separator is required. HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info GENERATE_CHI = NO CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO #--------------------------------------------------------------------------- # QHP Output Options #--------------------------------------------------------------------------- GENERATE_QHP = NO # Only re-enable in format-specific config files. 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 # Only re-enable in format-specific config files. ECLIPSE_DOC_ID = org.wxwidgets.doxygen #--------------------------------------------------------------------------- # LaTeX Output Options #--------------------------------------------------------------------------- GENERATE_LATEX = NO # Only re-enable in format-specific config files. LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = latexdocstart.inc LATEX_FOOTER = 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 # Only re-enable in format-specific config files. RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # Man Page Output Options #--------------------------------------------------------------------------- GENERATE_MAN = NO # Only re-enable in format-specific config files. MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- # XML Output Options #--------------------------------------------------------------------------- GENERATE_XML = NO # Only re-enable in format-specific config files. XML_OUTPUT = xml XML_SCHEMA = XML_DTD = XML_PROGRAMLISTING = NO # Default: YES #--------------------------------------------------------------------------- # AutoGen Definitions Output Options #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO # Only re-enable in format-specific config files. #--------------------------------------------------------------------------- # Perl Module Output Options #--------------------------------------------------------------------------- GENERATE_PERLMOD = NO # Only re-enable in format-specific config files. 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 = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Additions Related to External References #--------------------------------------------------------------------------- TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # dot Tool Options #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES # Default: NO DOT_NUM_THREADS = 0 DOT_FONTNAME = FreeSans # Default: Helvetica 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 DOTFILE_DIRS = MSCFILE_DIRS = 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 # Instead of setting a value for DOT_PATH it's easier and more portable to # put your dot utility in the PATH. On Windows you'll need to install GraphViz # tools, and then manually add it to the PATH environment variable. DOT_PATH =