From: Vadim Zeitlin Date: Fri, 14 Mar 2008 20:54:52 +0000 (+0000) Subject: rename Doxyfile.* to Doxyfile_* to avoid inappropriate extensions X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/be151c9a1c6b9f049bbbd2c6a1cea277a29e7e02 rename Doxyfile.* to Doxyfile_* to avoid inappropriate extensions git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52506 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/Doxyfile.all b/docs/doxygen/Doxyfile.all deleted file mode 100644 index 9befa124ef..0000000000 --- a/docs/doxygen/Doxyfile.all +++ /dev/null @@ -1,26 +0,0 @@ -############################################################################# -## Name: Doxyfile.all -## Purpose: Doxygen configuration file for generating all main formats -## Author: Francesco Montorsi -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -@INCLUDE = Doxyfile.inc - -#--------------------------------------------------------------------------- -# Generation switches -#--------------------------------------------------------------------------- - -GENERATE_HTMLHELP = YES -GENERATE_HTML = YES -GENERATE_XML = YES - -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_PERLMOD = YES -GENERATE_AUTOGEN_DEF = NO -GENERATE_TAGFILE = - -HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe diff --git a/docs/doxygen/Doxyfile.chm b/docs/doxygen/Doxyfile.chm deleted file mode 100644 index a7d2af8d91..0000000000 --- a/docs/doxygen/Doxyfile.chm +++ /dev/null @@ -1,26 +0,0 @@ -############################################################################# -## Name: Doxyfile.chm -## Purpose: Doxygen configuration file for generating CHM only -## Author: Francesco Montorsi -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -@INCLUDE = Doxyfile.inc - -#--------------------------------------------------------------------------- -# Generation switches -#--------------------------------------------------------------------------- - -GENERATE_HTMLHELP = YES -GENERATE_HTML = NO -GENERATE_XML = NO - -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_PERLMOD = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_TAGFILE = - -HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe diff --git a/docs/doxygen/Doxyfile.html b/docs/doxygen/Doxyfile.html deleted file mode 100644 index 889ba5de63..0000000000 --- a/docs/doxygen/Doxyfile.html +++ /dev/null @@ -1,26 +0,0 @@ -############################################################################# -## Name: Doxyfile.html -## Purpose: Doxygen configuration file for generating HTML only -## Author: Francesco Montorsi -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -@INCLUDE = Doxyfile.inc - -#--------------------------------------------------------------------------- -# Generation switches -#--------------------------------------------------------------------------- - -GENERATE_HTMLHELP = NO -GENERATE_HTML = YES -GENERATE_XML = NO - -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_PERLMOD = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_TAGFILE = - -HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc deleted file mode 100644 index e5ef3ffe7b..0000000000 --- a/docs/doxygen/Doxyfile.inc +++ /dev/null @@ -1,373 +0,0 @@ -############################################################################# -## Name: Doxyfile.inc -## Purpose: Main configuration file for the wxWidgets manual -## Author: Francesco Montorsi -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = wxWidgets -PROJECT_NUMBER = 2.9.0 -OUTPUT_DIRECTORY = out -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = -ALWAYS_DETAILED_SEC = YES -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -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 -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -DISTRIBUTE_GROUP_DOC = YES -SUBGROUPING = YES - -#--------------------------------------------------------------------------- -# Aliases -#--------------------------------------------------------------------------- - -# This is the most important part of the wxWidgets Doxyfile; aliases allow -# 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" - -# style aliases -ALIASES += beginStyleTable="\nStyles:" -ALIASES += style{1}="\li \1" -ALIASES += endStyleTable="\n" - -# extra style aliases -ALIASES += beginExtraStyleTable="
Extra styles:" -ALIASES += endExtraStyleTable="
" - -# 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:" - -# native implementation infos: -ALIASES += nativeimpl{1}="
Implementations:  native under \ref page_port_\1 port; a generic implementation is used elsewhere.
" -ALIASES += nativeimpl{2}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.
" -ALIASES += nativeimpl{3}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.
" -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.
" - -# 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: -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" - -# NOTE: these are important as you can't write in the docs -# just #ifdef since the # character is used by Doxygen -# for explicit linking; use the following aliases instead! -# However to avoid overwriting e.g. \if Doxygen command the _ -# character is postfixed -ALIASES += ifdef_="\#ifdef" -ALIASES += ifndef_="\#ifndef" -ALIASES += if_="\#if" -ALIASES += endif_="\#endif" - -# table aliases for 2 and 3 column tables -ALIASES += beginTable="
" -ALIASES += beginInvisibleTable="
" -ALIASES += row2col{2}="" -ALIASES += row2col{3}="" -ALIASES += row2col{4}="" -ALIASES += row2col{5}="" -ALIASES += row2col{6}="" -ALIASES += row2col{7}="" -ALIASES += row2col{8}="" -ALIASES += row2col{9}="" -ALIASES += row2col{10}="" -ALIASES += row3col{3}="" -ALIASES += row3col{4}="" -ALIASES += row3col{5}="" -ALIASES += row3col{6}="" -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
\1 \2,\3,\4,\5,\6
\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
\1 \2 \3
\1 \2 \3,\4
\1 \2 \3,\4,\5
\1 \2 \3,\4,\5,\6
\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
" - -# definition list aliases -# a definition list currently is rendered as 2-column table but it may use as -# well the
,
and
HTML tags in future. -# 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 += itemdef{2}="" -ALIASES += itemdef{3}="" -ALIASES += itemdef{4}="" -ALIASES += itemdef{5}="" -ALIASES += itemdef{6}="" -ALIASES += itemdef{7}="" -ALIASES += itemdef{8}="" -ALIASES += itemdef{9}="" -ALIASES += itemdef{10}="" -ALIASES += endDefList="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\4,\5
\1 \2,\3,\4,\5,\6
\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
" - -# See ENABLED_SECTIONS configuration key for more info about these: -ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n wxPerl note\n\n" -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="}" - - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = NO -EXTRACT_ANON_NSPACES = YES -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = NO -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_BY_SCOPE_NAME = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES - -# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords -ENABLED_SECTIONS = - -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES -FILE_VERSION_FILTER = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = YES -WARN_FORMAT = "$file:$line: $text " -WARN_LOGFILE = doxygen.log - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = ./mainpages ./groups ./overviews ../../interface -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.h *.txt -RECURSIVE = YES -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = YES -IMAGE_PATH = images -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = wx - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = htmlheader.inc -HTML_FOOTER = htmlfooter.inc -HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES -HTML_DYNAMIC_SECTIONS = NO -CHM_FILE = wx.chm -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 -#--------------------------------------------------------------------------- -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = latexdocstart.inc -PDF_HYPERLINKS = YES -USE_PDFLATEX = YES -LATEX_BATCHMODE = YES -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = YES -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = YES -CLASS_GRAPH = NO -COLLABORATION_GRAPH = NO -GROUP_GRAPHS = NO -UML_LOOK = NO -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = NO -INCLUDED_BY_GRAPH = NO -CALL_GRAPH = NO -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 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO diff --git a/docs/doxygen/Doxyfile.latex b/docs/doxygen/Doxyfile.latex deleted file mode 100644 index 19c4d60353..0000000000 --- a/docs/doxygen/Doxyfile.latex +++ /dev/null @@ -1,26 +0,0 @@ -############################################################################# -## Name: Doxyfile.latex -## Purpose: Doxygen configuration file for generating Latex only -## Author: Stefan Csomor -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -@INCLUDE = Doxyfile.inc - -#--------------------------------------------------------------------------- -# Generation switches -#--------------------------------------------------------------------------- - -GENERATE_HTMLHELP = NO -GENERATE_HTML = NO -GENERATE_XML = NO - -GENERATE_LATEX = YES -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_PERLMOD = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_TAGFILE = - -HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile.xml b/docs/doxygen/Doxyfile.xml deleted file mode 100644 index 8efe3112c9..0000000000 --- a/docs/doxygen/Doxyfile.xml +++ /dev/null @@ -1,26 +0,0 @@ -############################################################################# -## Name: Doxyfile.xml -## Purpose: Doxygen configuration file for generating XML only -## Author: Francesco Montorsi -## RCS-ID: $Id$ -## Licence: wxWindows license -############################################################################# - -@INCLUDE = Doxyfile.inc - -#--------------------------------------------------------------------------- -# Generation switches -#--------------------------------------------------------------------------- - -GENERATE_HTMLHELP = NO -GENERATE_HTML = NO -GENERATE_XML = YES - -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_PERLMOD = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_TAGFILE = - -HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile_all b/docs/doxygen/Doxyfile_all new file mode 100644 index 0000000000..5923b07584 --- /dev/null +++ b/docs/doxygen/Doxyfile_all @@ -0,0 +1,26 @@ +############################################################################# +## Name: Doxyfile.all +## Purpose: Doxygen configuration file for generating all main formats +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = YES +GENERATE_HTML = YES +GENERATE_XML = YES + +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_PERLMOD = YES +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = + +HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe diff --git a/docs/doxygen/Doxyfile_chm b/docs/doxygen/Doxyfile_chm new file mode 100644 index 0000000000..b5c44217a1 --- /dev/null +++ b/docs/doxygen/Doxyfile_chm @@ -0,0 +1,26 @@ +############################################################################# +## Name: Doxyfile.chm +## Purpose: Doxygen configuration file for generating CHM only +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = YES +GENERATE_HTML = NO +GENERATE_XML = NO + +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_PERLMOD = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = + +HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe diff --git a/docs/doxygen/Doxyfile_html b/docs/doxygen/Doxyfile_html new file mode 100644 index 0000000000..2f89afd705 --- /dev/null +++ b/docs/doxygen/Doxyfile_html @@ -0,0 +1,26 @@ +############################################################################# +## Name: Doxyfile.html +## Purpose: Doxygen configuration file for generating HTML only +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = NO +GENERATE_HTML = YES +GENERATE_XML = NO + +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_PERLMOD = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = + +HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc new file mode 100644 index 0000000000..05fa77f5d7 --- /dev/null +++ b/docs/doxygen/Doxyfile_inc @@ -0,0 +1,373 @@ +############################################################################# +## Name: Doxyfile_inc +## Purpose: Main configuration file for the wxWidgets manual +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = wxWidgets +PROJECT_NUMBER = 2.9.0 +OUTPUT_DIRECTORY = out +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +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 +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = YES +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Aliases +#--------------------------------------------------------------------------- + +# This is the most important part of the wxWidgets Doxyfile; aliases allow +# 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" + +# style aliases +ALIASES += beginStyleTable="\nStyles:" +ALIASES += style{1}="\li \1" +ALIASES += endStyleTable="\n" + +# extra style aliases +ALIASES += beginExtraStyleTable="
Extra styles:" +ALIASES += endExtraStyleTable="
" + +# 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:" + +# native implementation infos: +ALIASES += nativeimpl{1}="
Implementations:  native under \ref page_port_\1 port; a generic implementation is used elsewhere.
" +ALIASES += nativeimpl{2}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.
" +ALIASES += nativeimpl{3}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.
" +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.
" + +# 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: +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" + +# NOTE: these are important as you can't write in the docs +# just #ifdef since the # character is used by Doxygen +# for explicit linking; use the following aliases instead! +# However to avoid overwriting e.g. \if Doxygen command the _ +# character is postfixed +ALIASES += ifdef_="\#ifdef" +ALIASES += ifndef_="\#ifndef" +ALIASES += if_="\#if" +ALIASES += endif_="\#endif" + +# table aliases for 2 and 3 column tables +ALIASES += beginTable="
" +ALIASES += beginInvisibleTable="
" +ALIASES += row2col{2}="" +ALIASES += row2col{3}="" +ALIASES += row2col{4}="" +ALIASES += row2col{5}="" +ALIASES += row2col{6}="" +ALIASES += row2col{7}="" +ALIASES += row2col{8}="" +ALIASES += row2col{9}="" +ALIASES += row2col{10}="" +ALIASES += row3col{3}="" +ALIASES += row3col{4}="" +ALIASES += row3col{5}="" +ALIASES += row3col{6}="" +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
\1 \2,\3,\4,\5,\6
\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
\1 \2 \3
\1 \2 \3,\4
\1 \2 \3,\4,\5
\1 \2 \3,\4,\5,\6
\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
" + +# definition list aliases +# a definition list currently is rendered as 2-column table but it may use as +# well the
,
and
HTML tags in future. +# 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 += itemdef{2}="" +ALIASES += itemdef{3}="" +ALIASES += itemdef{4}="" +ALIASES += itemdef{5}="" +ALIASES += itemdef{6}="" +ALIASES += itemdef{7}="" +ALIASES += itemdef{8}="" +ALIASES += itemdef{9}="" +ALIASES += itemdef{10}="" +ALIASES += endDefList="
\1 \2
\1 \2,\3
\1 \2,\3,\4
\1 \2,\3,\4,\5
\1 \2,\3,\4,\5,\6
\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
" + +# See ENABLED_SECTIONS configuration key for more info about these: +ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n wxPerl note\n\n" +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="}" + + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = NO +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_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES + +# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords +ENABLED_SECTIONS = + +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_DIRECTORIES = YES +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES +WARN_FORMAT = "$file:$line: $text " +WARN_LOGFILE = doxygen.log + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ./mainpages ./groups ./overviews ../../interface +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.h *.txt +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = YES +IMAGE_PATH = images +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = wx + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = htmlheader.inc +HTML_FOOTER = htmlfooter.inc +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +HTML_DYNAMIC_SECTIONS = NO +CHM_FILE = wx.chm +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 +#--------------------------------------------------------------------------- +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = latexdocstart.inc +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = YES +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO +GROUP_GRAPHS = NO +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +CALL_GRAPH = NO +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 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO diff --git a/docs/doxygen/Doxyfile_latex b/docs/doxygen/Doxyfile_latex new file mode 100644 index 0000000000..a98afcdadb --- /dev/null +++ b/docs/doxygen/Doxyfile_latex @@ -0,0 +1,26 @@ +############################################################################# +## Name: Doxyfile.latex +## Purpose: Doxygen configuration file for generating Latex only +## Author: Stefan Csomor +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = NO +GENERATE_HTML = NO +GENERATE_XML = NO + +GENERATE_LATEX = YES +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_PERLMOD = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = + +HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile_xml b/docs/doxygen/Doxyfile_xml new file mode 100644 index 0000000000..6e1272352d --- /dev/null +++ b/docs/doxygen/Doxyfile_xml @@ -0,0 +1,26 @@ +############################################################################# +## Name: Doxyfile.xml +## Purpose: Doxygen configuration file for generating XML only +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = NO +GENERATE_HTML = NO +GENERATE_XML = YES + +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_PERLMOD = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = + +HHC_LOCATION =