X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2a6585b851262ff815d2f67b2245b44c55a6c854..dc215c81ff56b80625874c5523f97463b1c05614:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 2fb298c095..9c88595380 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 @@ -140,7 +147,7 @@ ALIASES += endTable="" # 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 += beginDefList="
" ALIASES += itemdef{2}="" ALIASES += itemdef{3}="" ALIASES += itemdef{4}="" @@ -153,9 +160,9 @@ ALIASES += itemdef{10}="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\ ALIASES += endDefList="
" # See ENABLED_SECTIONS configuration key for more info about these: -ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n wxPerl note\n\n" +ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n wxPerl Note:\n\n" ALIASES += endWxPerlOnly="\endif" -ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n wxPython note\n\n" +ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n wxPython Note:\n\n" ALIASES += endWxPythonOnly="\endif" # This is to get around a bug in Doxygen that prevents use of '{' or '}' @@ -191,7 +198,7 @@ GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords -ENABLED_SECTIONS = +ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES @@ -220,9 +227,9 @@ EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXCLUDE_SYMBOLS = -EXAMPLE_PATH = +EXAMPLE_PATH = ../ EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = YES +EXAMPLE_RECURSIVE = NO IMAGE_PATH = images INPUT_FILTER = FILTER_PATTERNS =