From: Francesco Montorsi Date: Thu, 28 Feb 2008 21:50:05 +0000 (+0000) Subject: splitted the Doxyfile in more files; now it's easy to generate only a single format... X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/85e43f4e9d0664d56143e731c3e38b8c44aa545a splitted the Doxyfile in more files; now it's easy to generate only a single format or all of them without editing the cfg files git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52182 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile deleted file mode 100644 index 3587de6ccb..0000000000 --- a/docs/doxygen/Doxyfile +++ /dev/null @@ -1,364 +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 = NO -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 = NO -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="\section class_events Events\n" -ALIASES += event{1}="\li \b \1" -ALIASES += event{2}="\li \b \1, \2" -ALIASES += endEventTable="\n" - -# style aliases -ALIASES += beginStyleTable="\section class_styles Styles\n" -ALIASES += style{1}="\li \b \c \1" -ALIASES += endStyleTable="\n" - -# extra style aliases -ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n" -ALIASES += endExtraStyleTable="\n" - -# misc aliases -ALIASES += library{1}="\section class_lib Library\n \ref page_libs_\1" -ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based." -ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b" - -# FIXME: we could also introduce additional tags for adding wx-specific infos -# to the documented classes/functions; some ideas are: -# @category{GUI classes} -# @nativeimpl{wxgtk,wxmsw} -# @genericimpl{wxuniv,wxmac} -# @onlyfor{wxmsw} -# @appeareance{button.png} - - -# IMPORTANT: the default \sa command does not generate a \section! -ALIASES += seealso="\section class_sa See also\n" - -# 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" - -# some formatting aliases -# NOTE: using and tags is different from using \c \b because in the last case -# \c gets applied to the first word following and \b to the second word following; -# we want both bold and typetext attributes to be applied to the same word! -ALIASES += true="true" -ALIASES += false="false" -ALIASES += NULL="NULL" - -# FIXME: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, -# @wxEmptyString, @wxNullIcon, etc etc - -# 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="
\b \1 \2
\b \1 \2,\3
\b \1 \2,\3,\4
\b \1 \2,\3,\4,\5
\b \1 \2,\3,\4,\5,\6
\b \1 \2,\3,\4,\5,\6,\7
\b \1 \2,\3,\4,\5,\6,\7,\8
\b \1 \2,\3,\4,\5,\6,\7,\8,\9
\b \1 \2,\3,\4,\5,\6,\7,\8,\9,\10
" - -# 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" - -# 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 = YES -HIDE_UNDOC_CLASSES = YES -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 = YES -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 = NO -FILE_VERSION_FILTER = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = NO -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text " -WARN_LOGFILE = doxygen.log - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = ./mainpages ./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 = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO -LATEX_BATCHMODE = NO -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 = NO -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.all b/docs/doxygen/Doxyfile.all new file mode 100644 index 0000000000..2d639b9aae --- /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: Doxyfile 52098 2008-02-26 00:05:33Z BP $ +## 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 = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_TAGFILE = NO + +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..ebf136546f --- /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: Doxyfile 52098 2008-02-26 00:05:33Z BP $ +## 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 = NO + +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..68b38e6907 --- /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: Doxyfile 52098 2008-02-26 00:05:33Z BP $ +## 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 = NO + +HHC_LOCATION = diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc new file mode 100644 index 0000000000..3587de6ccb --- /dev/null +++ b/docs/doxygen/Doxyfile.inc @@ -0,0 +1,364 @@ +############################################################################# +## 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 = NO +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 = NO +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="\section class_events Events\n" +ALIASES += event{1}="\li \b \1" +ALIASES += event{2}="\li \b \1, \2" +ALIASES += endEventTable="\n" + +# style aliases +ALIASES += beginStyleTable="\section class_styles Styles\n" +ALIASES += style{1}="\li \b \c \1" +ALIASES += endStyleTable="\n" + +# extra style aliases +ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n" +ALIASES += endExtraStyleTable="\n" + +# misc aliases +ALIASES += library{1}="\section class_lib Library\n \ref page_libs_\1" +ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based." +ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b" + +# FIXME: we could also introduce additional tags for adding wx-specific infos +# to the documented classes/functions; some ideas are: +# @category{GUI classes} +# @nativeimpl{wxgtk,wxmsw} +# @genericimpl{wxuniv,wxmac} +# @onlyfor{wxmsw} +# @appeareance{button.png} + + +# IMPORTANT: the default \sa command does not generate a \section! +ALIASES += seealso="\section class_sa See also\n" + +# 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" + +# some formatting aliases +# NOTE: using and tags is different from using \c \b because in the last case +# \c gets applied to the first word following and \b to the second word following; +# we want both bold and typetext attributes to be applied to the same word! +ALIASES += true="true" +ALIASES += false="false" +ALIASES += NULL="NULL" + +# FIXME: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, +# @wxEmptyString, @wxNullIcon, etc etc + +# 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="
\b \1 \2
\b \1 \2,\3
\b \1 \2,\3,\4
\b \1 \2,\3,\4,\5
\b \1 \2,\3,\4,\5,\6
\b \1 \2,\3,\4,\5,\6,\7
\b \1 \2,\3,\4,\5,\6,\7,\8
\b \1 \2,\3,\4,\5,\6,\7,\8,\9
\b \1 \2,\3,\4,\5,\6,\7,\8,\9,\10
" + +# 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" + +# 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 = YES +HIDE_UNDOC_CLASSES = YES +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 = YES +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 = NO +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text " +WARN_LOGFILE = doxygen.log + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ./mainpages ./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 = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +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 = NO +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.xml b/docs/doxygen/Doxyfile.xml new file mode 100644 index 0000000000..1f83485da0 --- /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: Doxyfile 52098 2008-02-26 00:05:33Z BP $ +## 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 = NO + +HHC_LOCATION = diff --git a/docs/doxygen/regen.bat b/docs/doxygen/regen.bat index b30c96e17b..7e4b481e71 100755 --- a/docs/doxygen/regen.bat +++ b/docs/doxygen/regen.bat @@ -4,7 +4,8 @@ REM This bash script regenerates the HTML doxygen version of the REM wxWidgets manual and adjusts the doxygen log to make it more REM readable. -doxygen +mkdir out +mkdir out\html REM this image is not automatically copied by Doxygen because it's not REM used in doxygen documentation but only in our html footer... @@ -13,3 +14,12 @@ copy images\powered-by-wxwidgets.png out\html REM this CSS is automatically copied by Doxygen because it's REM included by our custom html header... copy wxwidgets.css out\html + +REM +REM NOW RUN DOXYGEN +REM +REM NB: we do this _after_ copying the required files to the output folders +REM otherwise when generating the CHM file with Doxygen, those files are +REM not included! +REM +doxygen Doxyfile.all diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh index 2005887c9c..9a68595c41 100755 --- a/docs/doxygen/regen.sh +++ b/docs/doxygen/regen.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # $Id$ @@ -6,7 +6,7 @@ # wxWidgets manual and adjusts the doxygen log to make it more # readable. -doxygen +mkdir -p out/html # we need to copy files in this folder below # this image is not automatically copied by Doxygen because it's not # used in doxygen documentation but only in our html footer... @@ -16,6 +16,21 @@ cp images/powered-by-wxwidgets.png out/html # included by our custom html header... cp wxwidgets.css out/html +# +# NOW RUN DOXYGEN +# +# NB: we do this _after_ copying the required files to the output folders +# otherwise when generating the CHM file with Doxygen, those files are +# not included! +# +if [[ -z "$1" ]]; then + cfgfile="Doxyfile.all" +else + cfgfile="Doxyfile.$1" +fi + +doxygen $cfgfile + # Doxygen has the annoying habit to put the full path of the # affected files in the log file; remove it to make the log # more readable @@ -25,6 +40,6 @@ cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp mv temp doxygen.log # filter out the following warning which we don't care about -cat doxygen.log | grep -v ".*supplied.*as.*the.*argument.*is.*not.*an.*input.*file.*" >temp -mv temp doxygen.log +#cat doxygen.log | grep -v ".*supplied.*as.*the.*argument.*is.*not.*an.*input.*file.*" >temp +#mv temp doxygen.log