X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8d740f720363f249cebf5c871b4d1bdd623a8086..6c42e86d96dda763b66cbe982034b0c9f4237af5:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 8afbd597c6..40a0163643 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -3,7 +3,7 @@ ## Purpose: Main configuration file for the wxWidgets manual ## Author: Francesco Montorsi ## RCS-ID: $Id$ -## Licence: wxWindows license +## Licence: wxWindows licence ############################################################################# #--------------------------------------------------------------------------- @@ -12,7 +12,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = wxWidgets -PROJECT_NUMBER = 2.9.0 +PROJECT_NUMBER = 2.9.3 OUTPUT_DIRECTORY = out CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English @@ -52,9 +52,16 @@ SYMBOL_CACHE_SIZE = 0 # Aliases - for use when documenting C++ classes #--------------------------------------------------------------------------- -# event aliases -ALIASES = beginEventTable{1}="\n

Events

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

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:
" +# 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:
" @@ -76,7 +83,18 @@ ALIASES += flag{1}="
\li \1:
\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 += appearance{1}="\htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
\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 use when documenting any C++ entity @@ -85,6 +103,7 @@ ALIASES += appearance{1}="\htmlonly
Appearance # 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:" @@ -184,8 +203,8 @@ ALIASES += rightCurly="}" # Aliases - for use when documenting samples #--------------------------------------------------------------------------- -# For indicating the a directory containing a sample -ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim" +# 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/\1" # For refering to the corresponding sample in a class document or a overview # Usually placed in the queue of @see @@ -305,8 +324,10 @@ HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES HTML_DYNAMIC_SECTIONS = YES GENERATE_DOCSET = NO # Only change in format output configs -DOCSET_FEEDNAME = "wxWidgets" -DOCSET_BUNDLE_ID = org.wxwidgets.doxygen +DOCSET_FEEDNAME = "wxWidgets 2.9" +DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29 +DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen +DOCSET_PUBLISHER_NAME = wxWidgets Team 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 @@ -314,10 +335,10 @@ GENERATE_CHI = NO BINARY_TOC = NO TOC_EXPAND = NO GENERATE_QHP = NO -QCH_FILE = +QCH_FILE = QHP_NAMESPACE = org.wxwidgets.doxygen QHP_VIRTUAL_FOLDER = doc -QHG_LOCATION = +QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 1 GENERATE_TREEVIEW = NONE @@ -420,7 +441,7 @@ HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES DOT_FONTNAME = FreeSans DOT_FONTSIZE = 10 -DOT_FONTPATH = +DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = NO GROUP_GRAPHS = NO @@ -433,7 +454,6 @@ CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO DOT_IMAGE_FORMAT = png -DOT_PATH = DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 1000 @@ -442,6 +462,12 @@ 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; if you are on a Unix system this is usually +# done automatically; if you're on Windows you'll need to install GraphViz tools +# and then manually add it to the PATH environment variable +DOT_PATH = + #--------------------------------------------------------------------------- # Search Engine Options #---------------------------------------------------------------------------