X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/be151c9a1c6b9f049bbbd2c6a1cea277a29e7e02..9ef1ad0d2ccb6dee00b1adc495ce055edd27844b:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 05fa77f5d7..357a1d65d4 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -17,7 +17,7 @@ OUTPUT_DIRECTORY = out CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES +REPEAT_BRIEF = NO ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO @@ -47,28 +47,33 @@ SUBGROUPING = YES # us to keep the headers readable and "implement" wxWidgets-specific commands. # event aliases -ALIASES = beginEventTable="\nEvents:" -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" +ALIASES = beginEventTable{1}="\nEvents:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)


Event macros:
" +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="\nStyles:" -ALIASES += style{1}="\li \1" -ALIASES += endStyleTable="\n" +ALIASES += beginStyleTable="\nStyles:
" +ALIASES += style{1}="
\li \1:
" +ALIASES += endStyleTable="
\n" # extra style aliases -ALIASES += beginExtraStyleTable="
Extra styles:" -ALIASES += endExtraStyleTable="
" +ALIASES += beginExtraStyleTable="\nExtra styles:
" +ALIASES += endExtraStyleTable="
\n" + +# flag aliases +ALIASES += beginFlagTable="
" +ALIASES += flag{1}="
\li \1:
" +ALIASES += endFlagTable="
\n" # 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 += library{1}="
Library:  \ref page_libs_\1
" ALIASES += nolibrary="
Library:  None; this class implementation is entirely header-based.
" -ALIASES += stdobjects="Predefined objects:" +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.
" @@ -77,13 +82,15 @@ ALIASES += nativeimpl{3}="
Implementations: & 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: -ALIASES += onlyfor{1}="
Availability:  only available for the \ref page_port_\1 port.
" -ALIASES += onlyfor{2}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2 ports.
" -ALIASES += onlyfor{3}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.
" -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.
" +# 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" # creates appearance section: this should be used for all main GUI controls -ALIASES += appearance{1}="@htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" +ALIASES += appearance{1}="@htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" # IMPORTANT: the \headerfile command does not work everywhere we'd need it, # e.g. in the constants page we need to specify an header file @@ -191,17 +198,17 @@ GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords -ENABLED_SECTIONS = +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_DIRECTORIES = YES -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -QUIET = NO +QUIET = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES @@ -216,16 +223,16 @@ INPUT = ./mainpages ./groups ./overviews ../../interface INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h *.txt RECURSIVE = YES -EXCLUDE = +EXCLUDE = EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = ../ EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = YES +EXAMPLE_RECURSIVE = NO IMAGE_PATH = images -INPUT_FILTER = -FILTER_PATTERNS = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- @@ -250,14 +257,17 @@ IGNORE_PREFIX = wx #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- +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_STYLESHEET = HTML_ALIGN_MEMBERS = YES -HTML_DYNAMIC_SECTIONS = NO -CHM_FILE = wx.chm +GENERATE_HTMLHELP = NO # Only change in format output configs +HTML_DYNAMIC_SECTIONS = YES +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 @@ -269,12 +279,13 @@ TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- +GENERATE_LATEX = NO # Only change in format output configs LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4wide -EXTRA_PACKAGES = +EXTRA_PACKAGES = LATEX_HEADER = latexdocstart.inc PDF_HYPERLINKS = YES USE_PDFLATEX = YES @@ -284,15 +295,17 @@ LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- +GENERATE_RTF = NO # Only change in format output configs RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- +GENERATE_MAN = NO # Only change in format output configs MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO @@ -300,20 +313,21 @@ MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- +GENERATE_XML = NO # Only change in format output configs XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = +XML_SCHEMA = +XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- - +GENERATE_AUTOGEN_DEF = NO # Only change in format output configs #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO +GENERATE_PERLMOD = NO # Only change in format output configs PERLMOD_LATEX = YES PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = @@ -325,16 +339,17 @@ ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -TAGFILES = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl @@ -358,8 +373,8 @@ CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +DOT_PATH = +DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 1000 DOT_TRANSPARENT = NO @@ -371,3 +386,4 @@ DOT_CLEANUP = YES # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = NO +