path: root/lib/wx/api_gen/wx_doxygen.conf

# Doxyfile 1.8.7

#---------------------------------------------------------------------------
# Project Options
#---------------------------------------------------------------------------

DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = wx
PROJECT_NUMBER         = 2
PROJECT_BRIEF          =
PROJECT_LOGO           = 
OUTPUT_DIRECTORY       = ./
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    = ""
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
INLINE_SIMPLE_STRUCTS  = NO
TYPEDEF_HIDES_STRUCT   = NO
LOOKUP_CACHE_SIZE      = 0

# Aliases for documenting C++ classes
#---------------------------------------------------------------------------

# aliases for emitting wxEvents (e.g. wxWindow, wxTextCtrl, etc):
ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><div>"
ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><div>"
ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><div>"

# aliases for wxEvent-derived classes:
ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><div>"
ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><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"

# appearance
ALIASES += appearance{1}="\htmlonly \1 \endhtmlonly"
ALIASES += genericAppearance{1}="\htmlonly \1 \endhtmlonly"

# aliases for the creation of "named member groups"
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}="\htmlonly \1 \endhtmlonly"
ALIASES += category{2}="\htmlonly \1 \2 \endhtmlonly"
ALIASES += category{3}="\htmlonly \1 \2 \3 \endhtmlonly"

ALIASES += library{1}="\htmlonly \1 \endhtmlonly"
ALIASES += nolibrary="\htmlonly \endhtmlonly"

ALIASES += stdobjects="<span class='stdobj'>Predefined objects (include wx.hrl):</span>"

# native implementation infos:
ALIASES += nativeimpl{1}="\xmlonly <native>\1</native> \endxmlonly"
ALIASES += nativeimpl{2}="\xmlonly <native>\1,\2</native> \endxmlonly"
ALIASES += nativeimpl{3}="\xmlonly <native>\1,\2,\3</native> \endxmlonly"
ALIASES += nativeimpl{4}="\xmlonly <native>\1,\2,\3,\4</native> \endxmlonly"

# onlyfor:
ALIASES += onlyfor{1}="\xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
ALIASES += onlyfor{2}="\xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
ALIASES += onlyfor{3}="\xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
ALIASES += onlyfor{4}="\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>"

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>"
ALIASES += beginInvisibleTable="<table>"
ALIASES += row2col{2}="<tr><td>\1,\2</td></tr>"
ALIASES += row2col{3}="<tr><td>\1,\2,\3</td></tr>"
ALIASES += row2col{4}="<tr><td>\1,\2,\3,\4</td></tr>"
ALIASES += row2col{5}="<tr><td>\1,\2,\3,\4,\5</td></tr>"
ALIASES += row2col{6}="<tr><td>\1,\2,\3,\4,\5,\6</td></tr>"
ALIASES += row2col{7}="<tr><td>\1,\2,\3,\4,\5,\6,\7</td></tr>"
ALIASES += row2col{8}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += row2col{9}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += row2col{10}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += row3col{3}="<tr><td>\1,\2,\3</td></tr>"
ALIASES += row3col{4}="<tr><td>\1,\2,\3,\4</td></tr>"
ALIASES += row3col{5}="<tr><td>\1,\2,\3,\4,\5</td></tr>"
ALIASES += row3col{6}="<tr><td>\1,\2,\3,\4,\5,\6</td></tr>"
ALIASES += row3col{7}="<tr><td>\1,\2,\3,\4,\5,\6,\7</td></tr>"
ALIASES += row3col{8}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += row3col{9}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += row3col{10}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
ALIASES += endTable="</table>"

# definition list aliases
ALIASES += beginDefList="<table class='doclist'>"
ALIASES += itemdef{2}="<tr><td>\1,\2</td></tr>"
ALIASES += itemdef{3}="<tr><td>\1,\2,\3</td></tr>"
ALIASES += itemdef{4}="<tr><td>\1,\2,\3,\4</td></tr>"
ALIASES += itemdef{5}="<tr><td>\1,\2,\3,\4,\5</td></tr>"
ALIASES += itemdef{6}="<tr><td>\1,\2,\3,\4,\5,\6</td></tr>"
ALIASES += itemdef{7}="<tr><td>\1,\2,\3,\4,\5,\6,\7</td></tr>"
ALIASES += itemdef{8}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += itemdef{9}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += itemdef{10}="<tr><td>\1,\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += endDefList="</table>"

# Aliases for documenting wxPerl/wxPython-specific parts
#---------------------------------------------------------------------------

# See ENABLED_SECTIONS configuration key for more info about these:
ALIASES += beginWxPerlOnly="\if NOT_IGNORE_EXTERNAL_LANG"
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="}"

#---------------------------------------------------------------------------
# Build Options
#---------------------------------------------------------------------------

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PACKAGE        = NO
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
SHOW_GROUPED_MEMB_INC  = NO
FORCE_LOCAL_INCLUDES   = NO
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = YES
SORT_BY_SCOPE_NAME     = NO
STRICT_PROTO_MATCHING  = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = NO
SHOW_FILES             = YES
SHOW_NAMESPACES        = NO
FILE_VERSION_FILTER    =
LAYOUT_FILE            = DoxygenLayout.xml
CITE_BIB_FILES         =


#---------------------------------------------------------------------------
# Warning and Progress Message Options
#---------------------------------------------------------------------------

QUIET                  = YES
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES
WARN_FORMAT            = "$file:$line: $text"
WARN_LOGFILE           = wx_doxygen.log.warn


#---------------------------------------------------------------------------
# Input File Options
#---------------------------------------------------------------------------

INPUT                  = $(WX_DIR)/interface \
                         ./wx_extra
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.h *.md
RECURSIVE              = YES
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          = NO

#---------------------------------------------------------------------------
# Docset Output Options
#---------------------------------------------------------------------------

GENERATE_DOCSET        = NO

#---------------------------------------------------------------------------
# CHM Output Options
#---------------------------------------------------------------------------

GENERATE_HTMLHELP      = NO


#---------------------------------------------------------------------------
# QHP Output Options
#---------------------------------------------------------------------------

GENERATE_QHP           = NO


#---------------------------------------------------------------------------
# Eclipse Output Options
#---------------------------------------------------------------------------

GENERATE_ECLIPSEHELP   = NO


#---------------------------------------------------------------------------
# Other Output Options
#---------------------------------------------------------------------------

DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = NO
ENUM_VALUES_PER_LINE   = 1
TREEVIEW_WIDTH         = 250
EXT_LINKS_IN_WINDOW    = YES
FORMULA_FONTSIZE       = 10
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = NO
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         = NO

#---------------------------------------------------------------------------
# RTF Output Options
#---------------------------------------------------------------------------

GENERATE_RTF           = NO

#---------------------------------------------------------------------------
# Man Page Output Options
#---------------------------------------------------------------------------

GENERATE_MAN           = NO

#---------------------------------------------------------------------------
# XML Output Options
#---------------------------------------------------------------------------

GENERATE_XML           = YES
XML_OUTPUT             = ./wx_xml
XML_PROGRAMLISTING     = NO

#---------------------------------------------------------------------------
# DOCBOOK Output Options
#---------------------------------------------------------------------------

GENERATE_DOCBOOK       = NO

#---------------------------------------------------------------------------
# AutoGen Definitions Output Options
#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# Perl Module Output Options
#---------------------------------------------------------------------------

GENERATE_PERLMOD       = NO

#---------------------------------------------------------------------------
# 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       =
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = YES

#---------------------------------------------------------------------------
# dot Tool Options
#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES
#MSCGEN_PATH            =
DIA_PATH               =
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
DOT_NUM_THREADS        = 0
DOT_FONTNAME           =
DOT_FONTSIZE           = 10
DOT_FONTPATH           =
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = NO
GROUP_GRAPHS           = NO
UML_LOOK               = NO
UML_LIMIT_NUM_FIELDS   = 10
TEMPLATE_RELATIONS     = NO
INCLUDE_GRAPH          = NO
INCLUDED_BY_GRAPH      = NO
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = NO
DIRECTORY_GRAPH        = NO
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