X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/29f86fc1827816c9ab21202bb773caff854c2c10..ef40bc3dae5b9bce810fa6d44b5f43071109a2d9:/docs/doxygen/Doxyfile_inc diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 80a91c1f47..4a9b81d505 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -3,72 +3,115 @@ ## Purpose: Main configuration file for the wxWidgets manual ## Author: Francesco Montorsi ## RCS-ID: $Id$ -## Licence: wxWindows license +## Licence: wxWindows licence ############################################################################# #--------------------------------------------------------------------------- -# Project related configuration options +# Project Options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = wxWidgets -PROJECT_NUMBER = 2.9.0 +PROJECT_NUMBER = 2.9.5 +PROJECT_BRIEF = +PROJECT_LOGO = logo.png 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 -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +FULL_PATH_NAMES = YES +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:
" + +# 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:
" -# event aliases -ALIASES = beginEventTable{1}="\nEvents:

The following event handler macros redirect the events to member functions with a prototype: void handler(\1& event)

" -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" +# common event aliases: +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="\n

Styles

This class supports the following styles:

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

Extra styles

This class supports the following extra styles:

" +ALIASES += endExtraStyleTable="
\n" + +# flag aliases +ALIASES += beginFlagTable="
" +ALIASES += flag{1}="
\li \1:
" +ALIASES += endFlagTable="
\n" + +# creates appearance section: this should be used for all main GUI controls +# that look different in different ports. genericAppearance can be used for the +# controls that always look the same. +ALIASES += appearance{1}="\htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
\endhtmlonly" +ALIASES += genericAppearance{1}="\htmlonly
Appearance:
Generic 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 +#--------------------------------------------------------------------------- # 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 += 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: ALIASES += nativeimpl{1}="
Implementations:  native under \ref page_port_\1 port; a generic implementation is used elsewhere.
" @@ -84,25 +127,15 @@ 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" - -# 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 -# even if they're not inside a \class, \function or \struct command: +# 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" -# IMPORTANT: inside a \class, we want to specify the header file only once -# and not twice as the \headerfile command requires: -ALIASES += wxheader{1}="\headerfile \1 wx/\1" - -# the following alias avoids to repeat lots of times the same statement: -ALIASES += wxsince{1}="\since This function is new since wxWidgets version \1." - # some formatting aliases 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 @@ -115,8 +148,8 @@ ALIASES += if_="\#if" ALIASES += endif_="\#endif" # table aliases for 2 and 3 column tables -ALIASES += beginTable="
" -ALIASES += beginInvisibleTable="
" +ALIASES += beginTable="
" +ALIASES += beginInvisibleTable="
" ALIASES += row2col{2}="" ALIASES += row2col{3}="" ALIASES += row2col{4}="" @@ -134,7 +167,8 @@ ALIASES += row3col{7}="" ALIASES += row3col{8}="" ALIASES += row3col{9}="" ALIASES += row3col{10}="" -ALIASES += endTable="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2 \3,\4,\5,\6,\7
\1 \2 \3,\4,\5,\6,\7,\8
\1 \2 \3,\4,\5,\6,\7,\8,\9
\1 \2 \3,\4,\5,\6,\7,\8,\9,\10
" +ALIASES += hdr3col{3}="\1 \2 \3" +ALIASES += endTable="" # definition list aliases # a definition list currently is rendered as 2-column table but it may use as @@ -142,7 +176,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,22 +187,46 @@ ALIASES += itemdef{8}="" ALIASES += itemdef{10}="" ALIASES += endDefList="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\4 ALIASES += itemdef{9}="
\1 \2,\3,\4,\5,\6,\7,\8,\9
\1 \2,\3,\4,\5,\6,\7,\8,\9,\10
" +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 \n wxPerl note\n\n" +ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: " ALIASES += endWxPerlOnly="\endif" -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 '}' # inside of any aliased command in parameters. ALIASES += leftCurly="{" ALIASES += rightCurly="}" +#--------------------------------------------------------------------------- +# Aliases - for use when documenting samples +#--------------------------------------------------------------------------- + +# 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/samples/\1" + +# 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." +ALIASES += buildwith{2}="Build Note: You may need to build the wxWidgets library with \1 and \2 being set to 1 to be able to make it work, please read comments in @c for more info." #--------------------------------------------------------------------------- -# Build related configuration options +# Build Options #--------------------------------------------------------------------------- + EXTRACT_ALL = YES EXTRACT_PRIVATE = NO EXTRACT_STATIC = YES @@ -185,7 +243,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 @@ -193,16 +252,20 @@ 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 +SHOW_USED_FILES = NO SHOW_DIRECTORIES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = NO FILE_VERSION_FILTER = +LAYOUT_FILE = DoxygenLayout.xml #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Warning and Progress Message Options #--------------------------------------------------------------------------- + QUIET = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES @@ -212,8 +275,9 @@ WARN_FORMAT = "$file:$line: $text " WARN_LOGFILE = doxygen.log #--------------------------------------------------------------------------- -# configuration options related to the input files +# Input File Options #--------------------------------------------------------------------------- + INPUT = ./mainpages ./groups ./overviews ../../interface INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h *.txt @@ -231,8 +295,9 @@ FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Source Browsing Options #--------------------------------------------------------------------------- + SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES @@ -243,8 +308,9 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Alphabetical Class Index Options #--------------------------------------------------------------------------- + ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = wx @@ -255,25 +321,60 @@ IGNORE_PREFIX = wx 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_HEADER = custom_header.html +HTML_FOOTER = custom_footer.html +HTML_STYLESHEET = custom_stylesheet.css +HTML_EXTRA_FILES = jquery-1.3.2.min.js +HTML_COLORSTYLE_HUE = +HTML_COLORSTYLE_SAT = 255 +HTML_COLORSTYLE_GAMMA = 100 +HTML_TIMESTAMP = YES HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO # Only change in format output configs HTML_DYNAMIC_SECTIONS = YES +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 1 +GENERATE_TREEVIEW = NO +USE_INLINE_TREES = NO +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = YES +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES + +#--------------------------------------------------------------------------- +# configuration options related to the CHM output +#--------------------------------------------------------------------------- + +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 -DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = NO -TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- -# configuration options related to the LaTeX output +# configuration options related to the Qt Help Project output +#--------------------------------------------------------------------------- + +GENERATE_QHP = NO # Only change in format output configs +QCH_FILE = +QHP_NAMESPACE = org.wxwidgets.doxygen +QHP_VIRTUAL_FOLDER = doc +QHG_LOCATION = + +#--------------------------------------------------------------------------- +# configuration options related to the Docset output #--------------------------------------------------------------------------- + +GENERATE_DOCSET = NO # Only change in format output configs +DOCSET_FEEDNAME = "wxWidgets 2.9" +DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29 +DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen +DOCSET_PUBLISHER_NAME = wxWidgets Team + +#--------------------------------------------------------------------------- +# LaTeX Output Options +#--------------------------------------------------------------------------- + GENERATE_LATEX = NO # Only change in format output configs LATEX_OUTPUT = latex LATEX_CMD_NAME = latex @@ -288,8 +389,9 @@ LATEX_BATCHMODE = YES LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- -# configuration options related to the RTF output +# RTF Output Options #--------------------------------------------------------------------------- + GENERATE_RTF = NO # Only change in format output configs RTF_OUTPUT = rtf COMPACT_RTF = NO @@ -298,38 +400,43 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- -# configuration options related to the man page output +# Man Page Output Options #--------------------------------------------------------------------------- + GENERATE_MAN = NO # Only change in format output configs MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- -# configuration options related to the XML output +# XML Output Options #--------------------------------------------------------------------------- + GENERATE_XML = NO # Only change in format output configs XML_OUTPUT = xml XML_SCHEMA = XML_DTD = -XML_PROGRAMLISTING = YES +XML_PROGRAMLISTING = NO #--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output +# AutoGen Definitions Output Options #--------------------------------------------------------------------------- + GENERATE_AUTOGEN_DEF = NO # Only change in format output configs #--------------------------------------------------------------------------- -# configuration options related to the Perl module output +# Perl Module Output Options #--------------------------------------------------------------------------- + GENERATE_PERLMOD = NO # Only change in format output configs PERLMOD_LATEX = YES PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Preprocessor Options #--------------------------------------------------------------------------- + ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO @@ -341,8 +448,9 @@ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Additions Related to External References #--------------------------------------------------------------------------- + TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO @@ -350,13 +458,17 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# dot Tool Options #--------------------------------------------------------------------------- + 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 @@ -368,7 +480,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 @@ -377,8 +488,15 @@ 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 = + #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Search Engine Options #--------------------------------------------------------------------------- + SEARCHENGINE = NO