X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1dfb6ff0af7b4fb902350e6d649f3768e4f4ce81..f5fd8c2434b5947ba3035779ec537f0fee2b0d46:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index e8ad945d96..6735ab7b00 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 = NO +REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO @@ -26,29 +26,42 @@ STRIP_FROM_PATH = "$(WXWIDGETS)/" STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \ "$(WXWIDGETS)/interface/" SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = YES INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = NO DISTRIBUTE_GROUP_DOC = YES SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 + +# This is the most important part of the wxWidgets Doxyfile; aliases allow +# us to keep the headers readable and "implement" wxWidgets-specific commands: #--------------------------------------------------------------------------- -# Aliases +# Aliases - for use when documenting C++ classes #--------------------------------------------------------------------------- -# This is the most important part of the wxWidgets Doxyfile; aliases allow -# us to keep the headers readable and "implement" wxWidgets-specific commands. +# 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:
" -# event aliases -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 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:
" @@ -56,12 +69,12 @@ ALIASES += event{4}="
\li \1, \2, \3, \4:
\n" # style aliases -ALIASES += beginStyleTable="\nStyles:
" +ALIASES += beginStyleTable="\n

Styles

This class supports the following styles:

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

Extra styles

This class supports the following extra styles:

" ALIASES += endExtraStyleTable="
\n" # flag aliases @@ -69,11 +82,19 @@ ALIASES += beginFlagTable="
" ALIASES += flag{1}="
\li \1:
" ALIASES += endFlagTable="
\n" +# 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 - for use when 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 += library{1}="
Library:  \ref page_libs_\1
" -ALIASES += nolibrary="
Library:  None; this class implementation is entirely header-based.
" +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: @@ -90,9 +111,6 @@ ALIASES += onlyfor{2}="
Availability:   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" - # 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" @@ -101,6 +119,7 @@ ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim" 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 @@ -152,6 +171,11 @@ ALIASES += itemdef{8}="\1 \2,\3,\4 ALIASES += itemdef{9}="\1 \2,\3,\4,\5,\6,\7,\8,\9" ALIASES += itemdef{10}="\1 \2,\3,\4,\5,\6,\7,\8,\9,\10" ALIASES += endDefList="" +ALIASES += stock{3}="\1 @image html gtk-\2.png\n\3" + +#--------------------------------------------------------------------------- +# Aliases - for use when documenting wxPerl/wxPython-specific parts +#--------------------------------------------------------------------------- # See ENABLED_SECTIONS configuration key for more info about these: ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: " @@ -164,16 +188,22 @@ ALIASES += endWxPythonOnly="\endif" ALIASES += leftCurly="{" ALIASES += rightCurly="}" -# Sample documentation related aliases +#--------------------------------------------------------------------------- +# Aliases - for use when documenting samples +#--------------------------------------------------------------------------- + # For indicating the a directory containing a sample ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim" + # 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." @@ -199,7 +229,8 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655 +SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order. +SORT_GROUP_NAMES = YES SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES @@ -212,8 +243,10 @@ ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = NO SHOW_DIRECTORIES = YES -#SHOW_FILES = YES # Doxygen 1.5.6+ only +SHOW_FILES = YES +SHOW_NAMESPACES = NO FILE_VERSION_FILTER = +LAYOUT_FILE = DoxygenLayout.xml #--------------------------------------------------------------------------- # Warning and Progress Message Options @@ -221,7 +254,7 @@ FILE_VERSION_FILTER = QUIET = YES WARNINGS = YES -WARN_IF_UNDOCUMENTED = NO +WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_FORMAT = "$file:$line: $text " @@ -278,17 +311,26 @@ HTML_HEADER = htmlheader.inc HTML_FOOTER = htmlfooter.inc HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO # Only change in format output configs HTML_DYNAMIC_SECTIONS = YES +GENERATE_DOCSET = NO # Only change in format output configs +DOCSET_FEEDNAME = "wxWidgets" +DOCSET_BUNDLE_ID = org.wxwidgets.doxygen +GENERATE_HTMLHELP = NO # Only change in format output configs 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 +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.wxwidgets.doxygen +QHP_VIRTUAL_FOLDER = doc +QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 1 -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = NONE TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # LaTeX Output Options @@ -384,7 +426,10 @@ CLASS_DIAGRAMS = YES MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES -CLASS_GRAPH = NO +DOT_FONTNAME = FreeSans +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES COLLABORATION_GRAPH = NO GROUP_GRAPHS = NO UML_LOOK = NO