From 78226dacc2d087acc0a1acfb0bd15c7cc9773c58 Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Sat, 3 Nov 2012 18:08:45 +0000 Subject: [PATCH] Upgraded Doxygen to 1.8.2 for the docs. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72868 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile | 543 +++++++++++++++ docs/doxygen/DoxygenLayout.xml | 39 +- docs/doxygen/custom_footer.html | 17 +- docs/doxygen/custom_header.html | 16 +- docs/doxygen/custom_stylesheet.css | 1027 ---------------------------- docs/doxygen/extra_stylesheet.css | 113 +++ 6 files changed, 699 insertions(+), 1056 deletions(-) create mode 100644 docs/doxygen/Doxyfile delete mode 100644 docs/doxygen/custom_stylesheet.css create mode 100644 docs/doxygen/extra_stylesheet.css diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile new file mode 100644 index 0000000000..ddf3c98b4d --- /dev/null +++ b/docs/doxygen/Doxyfile @@ -0,0 +1,543 @@ +# Doxyfile 1.8.2 + +#--------------------------------------------------------------------------- +# Project Options +#--------------------------------------------------------------------------- + +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = wxWidgets +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 = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES # Default: NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = "$(WXWIDGETS)/" +STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \ + "$(WXWIDGETS)/interface/" +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = YES # Default: NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 4 +TCL_SUBST = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = NO # Default: YES +DISTRIBUTE_GROUP_DOC = YES # Default: NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO # TODO: Examine this setting. +INLINE_SIMPLE_STRUCTS = NO # TODO: Examine this setting. +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 +LOOKUP_CACHE_SIZE = 0 + + +#--------------------------------------------------------------------------- +# Aliases +#--------------------------------------------------------------------------- + +# This is the most important part of the wxWidgets Doxyfile. Aliases allow +# us to keep the headers readable and "implement" wxWidgets-specific commands. + +# Aliases for documenting C++ classes +#--------------------------------------------------------------------------- + +# 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:
" +ALIASES += event{4}="
\li \1, \2, \3, \4:
" +ALIASES += endEventTable="
\n" + +# style aliases +ALIASES += beginStyleTable="\n

Styles

This class supports the following styles:

" +ALIASES += style{1}="
\li \1:
" +ALIASES += endStyleTable="
\n" + +# extra style aliases +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:
\endhtmlonly\n\image html wxmsw/\1 \"wxMSW Appearance\"\n\htmlonly\endhtmlonly\n\image html wxgtk/\1 \"wxGTK Appearance\"\n\htmlonly\endhtmlonly\n\image html wxmac/\1 \"wxOSX Appearance\"\n\htmlonly
\endhtmlonly" +ALIASES += genericAppearance{1}="\htmlonly
Appearance:
\endhtmlonly\n\image html generic/\1 \"Generic Appearance\"\n\htmlonly
\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 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 += 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.
" +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: +# NOTE: we need to be able to retrieve these infos also from the XML output, thus +# we use the \xmlonly and \endxmlonly commands to include custom XML tags +ALIASES += onlyfor{1}="
Availability:  only available for the \ref page_port_\1 port.
\xmlonly \1 \endxmlonly" +ALIASES += onlyfor{2}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2 ports.
\xmlonly \1,\2 \endxmlonly" +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" + +# 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" + +# 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 +# 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 += hdr3col{3}="" +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
\1 \2 \3
" + +# 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
" +ALIASES += stock{3}="\1 @image html gtk-\2.png\n\3" + +# Aliases for documenting wxPerl/wxPython-specific parts +#--------------------------------------------------------------------------- + +# See ENABLED_SECTIONS configuration key for more info about these: +ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL wxPerl Note: " +ALIASES += endWxPerlOnly="\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 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 Options +#--------------------------------------------------------------------------- + +EXTRACT_ALL = YES # Default: NO +EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = YES # Default: NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = YES # TODO: Default: NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = NO # Default: YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order. +SORT_MEMBERS_CTORS_1ST = NO # Default: NO +SORT_GROUP_NAMES = YES # Default: NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES + +# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords +ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL + +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO # Default: YES +SHOW_FILES = YES +SHOW_NAMESPACES = NO # TODO: Default: YES +FILE_VERSION_FILTER = +LAYOUT_FILE = DoxygenLayout.xml +CITE_BIB_FILES = + + +#--------------------------------------------------------------------------- +# Warning and Progress Message Options +#--------------------------------------------------------------------------- + +QUIET = YES # Default: NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES # Default: NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = doxygen.log + + +#--------------------------------------------------------------------------- +# Input File Options +#--------------------------------------------------------------------------- + +INPUT = mainpages groups overviews ../../interface +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.h +RECURSIVE = YES # Default: NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = ../ +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = images +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = + + +#--------------------------------------------------------------------------- +# Source Browsing Options +#--------------------------------------------------------------------------- + +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 # Default: YES + + +#--------------------------------------------------------------------------- +# Alphabetical Class Index Options +#--------------------------------------------------------------------------- + +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = wx + + +#--------------------------------------------------------------------------- +# HTML Output Options +#--------------------------------------------------------------------------- + +GENERATE_HTML = YES # Only re-enable in format-specific config files. +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = custom_header.html +HTML_FOOTER = custom_footer.html +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = extra_stylesheet.css +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 # Default: 220 +HTML_COLORSTYLE_SAT = 255 # Default: 100 +HTML_COLORSTYLE_GAMMA = 100 # Default: 80 +HTML_TIMESTAMP = YES +HTML_DYNAMIC_SECTIONS = YES # Default: NO +HTML_INDEX_NUM_ENTRIES = 100 +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 1 # Default: 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = YES # Default: NO +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +USE_MATHJAX = NO +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_EXTENSIONS = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO + + +#--------------------------------------------------------------------------- +# Docset Output Options +#--------------------------------------------------------------------------- + +GENERATE_DOCSET = NO # Only re-enable in format-specific config files. +DOCSET_FEEDNAME = "wxWidgets 2.9" +DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29 +DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen +DOCSET_PUBLISHER_NAME = wxWidgets Team + + +#--------------------------------------------------------------------------- +# CHM Output Options +#--------------------------------------------------------------------------- + +GENERATE_HTMLHELP = NO # Only re-enable in format-specific config files. +CHM_FILE = ..\wx.chm # Windows style separator is required. +HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO + + +#--------------------------------------------------------------------------- +# QHP Output Options +#--------------------------------------------------------------------------- + +GENERATE_QHP = NO # Only re-enable in format-specific config files. +QCH_FILE = +QHP_NAMESPACE = org.wxwidgets.doxygen +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = + + +#--------------------------------------------------------------------------- +# Eclipse Output Options +#--------------------------------------------------------------------------- + +GENERATE_ECLIPSEHELP = NO # Only re-enable in format-specific config files. +ECLIPSE_DOC_ID = org.wxwidgets.doxygen + + +#--------------------------------------------------------------------------- +# LaTeX Output Options +#--------------------------------------------------------------------------- + +GENERATE_LATEX = NO # Only re-enable in format-specific config files. +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = latexdocstart.inc +LATEX_FOOTER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES # Default: NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +LATEX_BIB_STYLE = plain + + +#--------------------------------------------------------------------------- +# RTF Output Options +#--------------------------------------------------------------------------- + +GENERATE_RTF = NO # Only re-enable in format-specific config files. +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = + + +#--------------------------------------------------------------------------- +# Man Page Output Options +#--------------------------------------------------------------------------- + +GENERATE_MAN = NO # Only re-enable in format-specific config files. +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO + + +#--------------------------------------------------------------------------- +# XML Output Options +#--------------------------------------------------------------------------- + +GENERATE_XML = NO # Only re-enable in format-specific config files. +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = NO # Default: YES + + +#--------------------------------------------------------------------------- +# AutoGen Definitions Output Options +#--------------------------------------------------------------------------- + +GENERATE_AUTOGEN_DEF = NO # Only re-enable in format-specific config files. + + +#--------------------------------------------------------------------------- +# Perl Module Output Options +#--------------------------------------------------------------------------- + +GENERATE_PERLMOD = NO # Only re-enable in format-specific config files. +PERLMOD_LATEX = YES # Default: NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = + + +#--------------------------------------------------------------------------- +# Preprocessor Options +#--------------------------------------------------------------------------- + +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 + + +#--------------------------------------------------------------------------- +# Additions Related to External References +#--------------------------------------------------------------------------- + +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl + + +#--------------------------------------------------------------------------- +# dot Tool Options +#--------------------------------------------------------------------------- + +CLASS_DIAGRAMS = YES +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES # Default: NO +DOT_NUM_THREADS = 0 +DOT_FONTNAME = FreeSans # Default: Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO # Default: YES +GROUP_GRAPHS = NO # Default: YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO # Default: YES +INCLUDED_BY_GRAPH = NO # Default: YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = NO # TODO: Default: YES +DIRECTORY_GRAPH = NO # Default: YES +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOTFILE_DIRS = +MSCFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 1000 # Default: 0 +DOT_TRANSPARENT = NO +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. On Windows you'll need to install GraphViz +# tools, and then manually add it to the PATH environment variable. +DOT_PATH = diff --git a/docs/doxygen/DoxygenLayout.xml b/docs/doxygen/DoxygenLayout.xml index 5e96d2e0a0..55886d6215 100644 --- a/docs/doxygen/DoxygenLayout.xml +++ b/docs/doxygen/DoxygenLayout.xml @@ -2,24 +2,23 @@ - - + + - - + + - + - - + + - - + + - - + @@ -63,6 +62,7 @@ + @@ -78,18 +78,19 @@ - + + - + @@ -100,13 +101,14 @@ - + + @@ -116,6 +118,7 @@ + @@ -131,11 +134,12 @@ - - - + + + + @@ -152,6 +156,7 @@ + diff --git a/docs/doxygen/custom_footer.html b/docs/doxygen/custom_footer.html index 63b43891c0..290c0c0278 100644 --- a/docs/doxygen/custom_footer.html +++ b/docs/doxygen/custom_footer.html @@ -1,16 +1,19 @@ + + + $generatedby Doxygen $doxygenversion + + +
@@ -18,4 +21,4 @@ - + \ No newline at end of file diff --git a/docs/doxygen/custom_header.html b/docs/doxygen/custom_header.html index 3fd14cec6a..8c4520b279 100644 --- a/docs/doxygen/custom_header.html +++ b/docs/doxygen/custom_header.html @@ -6,14 +6,16 @@ $projectname: $title $title - - + + $treeview $search $mathjax + +$extrastylesheet -
+
@@ -21,9 +23,13 @@ $mathjax - Logo + + + wxWidgets + + - + Version: $projectnumber diff --git a/docs/doxygen/custom_stylesheet.css b/docs/doxygen/custom_stylesheet.css deleted file mode 100644 index e755d7fe3d..0000000000 --- a/docs/doxygen/custom_stylesheet.css +++ /dev/null @@ -1,1027 +0,0 @@ -/***************************************************************************** -** Name: custom_stylesheet.css -** Purpose: The wxWidgets documentation CSS; a customized version of -** the standard Doxygen CSS -** Author: Doxygen team -** RCS-ID: $Id$ -** Licence: wxWindows licence -*****************************************************************************/ - -body, table, div, p, dl { - font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; - font-size: 13px; - line-height: 1.5; -} - -/* @group Heading Levels */ - -h1 { - font-size: 150%; -} - -.title { - font-size: 150%; - font-weight: bold; - margin: 10px 2px; -} - -h2 { - font-size: 120%; -} - -h3 { - font-size: 100%; -} - -dt { - font-weight: bold; -} - -div.multicol { - -moz-column-gap: 1em; - -webkit-column-gap: 1em; - -moz-column-count: 3; - -webkit-column-count: 3; -} - -p.startli, p.startdd, p.starttd { - margin-top: 2px; -} - -p.endli { - margin-bottom: 0px; -} - -p.enddd { - margin-bottom: 4px; -} - -p.endtd { - margin-bottom: 2px; -} - -/* @end */ - -caption { - font-weight: bold; -} - -span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.qindex, div.navtab{ - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; -} - -div.qindex, div.navpath { - width: 100%; - line-height: 140%; -} - -div.navtab { - margin-right: 15px; -} - -/* @group Link Styling */ - -a { - color: #3D578C; - font-weight: normal; - text-decoration: none; -} - -.contents a:visited { - color: #4665A2; -} - -a:hover { - text-decoration: underline; -} - -a.qindex { - font-weight: bold; -} - -a.qindexHL { - font-weight: bold; - background-color: #9CAFD4; - color: #ffffff; - border: 1px double #869DCA; -} - -.contents a.qindexHL:visited { - color: #ffffff; -} - -a.el { - font-weight: bold; -} - -a.elRef { -} - -a.code { - color: #4665A2; -} - -a.codeRef { - color: #4665A2; -} - -/* @end */ - -dl.el { - margin-left: -1cm; -} - -.fragment { - font-family: monospace, fixed; - font-size: 105%; -} - -pre.fragment { - border: 1px solid #C4CFE5; - background-color: #FBFCFD; - padding: 4px 6px; - margin: 4px 8px 4px 2px; - overflow: auto; - word-wrap: break-word; - font-size: 9pt; - line-height: 125%; -} - -div.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px; - padding: 0.2em; - border: solid thin #333; - border-radius: 0.5em; - -webkit-border-radius: .5em; - -moz-border-radius: .5em; - box-shadow: 2px 2px 3px #999; - -webkit-box-shadow: 2px 2px 3px #999; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); - background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - font-weight: bold; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background-color: white; - color: black; - margin: 0; -} - -div.contents { - margin-top: 10px; - margin-left: 8px; - margin-right: 8px; -} - -td.indexkey { - background-color: #EBEFF6; - font-weight: bold; - border: 1px solid #C4CFE5; - margin: 2px 0px 2px 0; - padding: 2px 10px; - white-space: nowrap; - vertical-align: top; -} - -td.indexvalue { - background-color: #EBEFF6; - border: 1px solid #C4CFE5; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #EEF1F7; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { - -} - -img.formulaInl { - vertical-align: middle; -} - -div.center { - text-align: center; - margin-top: 0px; - margin-bottom: 0px; - padding: 0px; -} - -div.center img { - border: 0px; -} - -address.footer { - margin: 1em; - text-align: right; -} - -img.footer { - border: 0px; - vertical-align: middle; -} - -/* @group Code Colorization */ - -span.keyword { - color: #008000 -} - -span.keywordtype { - color: #604020 -} - -span.keywordflow { - color: #e08000 -} - -span.comment { - color: #800000 -} - -span.preprocessor { - color: #806020 -} - -span.stringliteral { - color: #002080 -} - -span.charliteral { - color: #008080 -} - -span.vhdldigit { - color: #ff00ff -} - -span.vhdlchar { - color: #000000 -} - -span.vhdlkeyword { - color: #700070 -} - -span.vhdllogic { - color: #ff0000 -} - -/* @end */ - -/* -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -*/ - -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #A3B4D7; -} - -th.dirtab { - background: #EBEFF6; - font-weight: bold; -} - -hr { - height: 0px; - border: none; - border-top: 1px solid #4A6AAA; -} - -hr.footer { - height: 1px; - margin: 2em 0em 0em 0em; -} - -/* @group Member Descriptions */ - -table.memberdecls { - border-spacing: 0px; - padding: 0px; -} - -.mdescLeft, .mdescRight, -.memItemLeft, .memItemRight, -.memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #F9FAFC; - border: none; - margin: 4px; - padding: 1px 0 0 8px; -} - -.mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - color: #555; -} - -.memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid #C4CFE5; -} - -.memItemLeft, .memTemplItemLeft { - white-space: nowrap; -} - -.memItemRight { - width: 100%; -} - -.memTemplParams { - color: #4665A2; - white-space: nowrap; -} - -/* @end */ - -/* @group Member Details */ - -/* Styles for detailed member documentation */ - -.memtemplate { - font-size: 80%; - color: #4665A2; - font-weight: normal; - margin-left: 9px; -} - -.memnav { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.mempage { - width: 100%; -} - -.memitem { - padding: 0; - margin-bottom: 10px; - margin-right: 5px; -} - -.memname { - white-space: nowrap; - font-weight: bold; - margin-left: 6px; -} - -.memproto, dl.reflist dt { - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 6px 0px 6px 0px; - color: #253555; - font-weight: bold; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - /* opera specific markup */ - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - border-top-right-radius: 8px; - border-top-left-radius: 8px; - /* firefox specific markup */ - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - -moz-border-radius-topright: 8px; - -moz-border-radius-topleft: 8px; - /* webkit specific markup */ - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - -webkit-border-top-right-radius: 8px; - -webkit-border-top-left-radius: 8px; - background-image:url('nav_f.png'); - background-repeat:repeat-x; - background-color: #CBDCFE; - -} - -.memdoc, dl.reflist dd { - border-bottom: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 2px 5px; - background-color: #FBFCFD; - border-top-width: 0; - /* opera specific markup */ - border-bottom-left-radius: 8px; - border-bottom-right-radius: 8px; - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - /* firefox specific markup */ - -moz-border-radius-bottomleft: 8px; - -moz-border-radius-bottomright: 8px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); - /* webkit specific markup */ - -webkit-border-bottom-left-radius: 8px; - -webkit-border-bottom-right-radius: 8px; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); -} - -dl.reflist dt { - padding: 5px; -} - -dl.reflist dd { - margin: 0px 0px 10px 0px; - padding: 5px; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; -} -.paramname em { - font-style: normal; -} - -.params, .retval, .exception, .tparams { - border-spacing: 6px 2px; -} - -.params .paramname, .retval .paramname { - font-weight: bold; - vertical-align: top; -} - -.params .paramtype { - font-style: italic; - vertical-align: top; -} - -.params .paramdir { - font-family: "courier new",courier,monospace; - vertical-align: top; -} - - - - -/* @end */ - -/* @group Directory (tree) */ - -/* for the tree view */ - -.ftvtree { - font-family: sans-serif; - margin: 0px; -} - -/* these are for tree view when used as main index */ - -.directory { - font-size: 9pt; - font-weight: bold; - margin: 5px; -} - -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -/* -The following two styles can be used to replace the root node title -with an image of your choice. Simply uncomment the next two styles, -specify the name of your image and be sure to set 'height' to the -proper pixel height of your image. -*/ - -/* -.directory h3.swap { - height: 61px; - background-repeat: no-repeat; - background-image: url("yourimage.gif"); -} -.directory h3.swap span { - display: none; -} -*/ - -.directory > h3 { - margin-top: 0; -} - -.directory p { - margin: 0px; - white-space: nowrap; -} - -.directory div { - display: none; - margin: 0px; -} - -.directory img { - vertical-align: -30%; -} - -/* these are for tree view when not used as main index */ - -.directory-alt { - font-size: 100%; - font-weight: bold; -} - -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -.directory-alt > h3 { - margin-top: 0; -} - -.directory-alt p { - margin: 0px; - white-space: nowrap; -} - -.directory-alt div { - display: none; - margin: 0px; -} - -.directory-alt img { - vertical-align: -30%; -} - -/* @end */ - -div.dynheader { - margin-top: 8px; -} - -address { - font-style: normal; - color: #2A3D61; -} - -table.doxtable { - border-collapse:collapse; -} - -table.doxtable td, table.doxtable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -table.doxtable th { - background-color: #374F7F; - color: #FFFFFF; - font-size: 110%; - padding-bottom: 4px; - padding-top: 5px; - text-align:left; -} - -table.fieldtable { - width: 100%; - margin-bottom: 10px; - border: 1px solid #A8B8D9; - border-spacing: 0px; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); - box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); -} - -.fieldtable td, .fieldtable th { - padding: 3px 7px 2px; -} - -.fieldtable td.fieldtype, .fieldtable td.fieldname { - white-space: nowrap; - border-right: 1px solid #A8B8D9; - border-bottom: 1px solid #A8B8D9; - vertical-align: top; -} - -.fieldtable td.fielddoc { - border-bottom: 1px solid #A8B8D9; - width: 100%; -} - -.fieldtable tr:last-child td { - border-bottom: none; -} - -.fieldtable th { - background-image:url('nav_f.png'); - background-repeat:repeat-x; - background-color: #E2E8F2; - font-size: 90%; - color: #253555; - padding-bottom: 4px; - padding-top: 5px; - text-align:left; - -moz-border-radius-topleft: 4px; - -moz-border-radius-topright: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - border-top-left-radius: 4px; - border-top-right-radius: 4px; - border-bottom: 1px solid #A8B8D9; -} - - -.tabsearch { - top: 0px; - left: 10px; - height: 36px; - background-image: url('tab_b.png'); - z-index: 101; - overflow: hidden; - font-size: 13px; -} - -.navpath ul -{ - font-size: 11px; - background-image:url('tab_b.png'); - background-repeat:repeat-x; - height:30px; - line-height:30px; - color:#8AA0CC; - border:solid 1px #C2CDE4; - overflow:hidden; - margin:0px; - padding:0px; -} - -.navpath li -{ - list-style-type:none; - float:left; - padding-left:10px; - padding-right:15px; - background-image:url('bc_s.png'); - background-repeat:no-repeat; - background-position:right; - color:#364D7C; -} - -.navpath li.navelem a -{ - height:32px; - display:block; - text-decoration: none; - outline: none; -} - -.navpath li.navelem a:hover -{ - color:#6884BD; -} - -.navpath li.footer -{ - list-style-type:none; - float:right; - padding-left:10px; - padding-right:15px; - background-image:none; - background-repeat:no-repeat; - background-position:right; - color:#364D7C; - font-size: 8pt; -} - - -div.summary -{ - float: right; - font-size: 8pt; - padding-right: 5px; - width: 50%; - text-align: right; -} - -div.summary a -{ - white-space: nowrap; -} - -div.ingroups -{ - margin-left: 5px; - font-size: 8pt; - padding-left: 5px; - width: 50%; - text-align: left; -} - -div.ingroups a -{ - white-space: nowrap; -} - -div.header -{ - background-image:url('nav_h.png'); - background-repeat:repeat-x; - background-color: #F9FAFC; - margin: 0px; - border-bottom: 1px solid #C4CFE5; -} - -div.headertitle -{ - padding: 5px 5px 5px 7px; -} - -dl -{ - padding: 0 0 0 10px; -} - -dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug -{ - border-left:4px solid; - padding: 0 0 0 6px; -} - -dl.note -{ - border-color: #D0C000; -} - -dl.warning, dl.attention -{ - border-color: #FF0000; -} - -dl.pre, dl.post, dl.invariant -{ - border-color: #00D000; -} - -dl.deprecated -{ - border-color: #505050; -} - -dl.todo -{ - border-color: #00C0E0; -} - -dl.test -{ - border-color: #3030E0; -} - -dl.bug -{ - border-color: #C08050; -} - -#projectlogo -{ - padding: 0.5em; - text-align: left; - vertical-align: bottom; - border-collapse: separate; -} - -#projectlogo img -{ - border: 0px none; -} - -#projectname -{ - font: 300% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 2px 0px; -} - -#projectbrief -{ - font: 120% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0px; -} - -#projectnumber -{ - font: 120% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0.5em; -} - -#titlearea -{ - padding: 0px; - margin: 0px; - width: 100%; - border-bottom: 1px solid #5373B4; -} - -.image -{ - text-align: center; -} - -.dotgraph -{ - text-align: center; -} - -.mscgraph -{ - text-align: center; -} - -.caption -{ - font-weight: bold; -} - -div.zoom -{ - border: 1px solid #90A5CE; -} - -dl.citelist { - margin-bottom:50px; -} - -dl.citelist dt { - color:#334975; - float:left; - font-weight:bold; - margin-right:10px; - padding:5px; -} - -dl.citelist dd { - margin:2px 0; - padding:5px 0; -} - -@media print -{ - #top { display: none; } - #side-nav { display: none; } - #nav-path { display: none; } - body { overflow:visible; } - h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } - .summary { display: none; } - .memitem { page-break-inside: avoid; } - #doc-content - { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } - pre.fragment - { - overflow: visible; - text-wrap: unrestricted; - white-space: -moz-pre-wrap; /* Moz */ - white-space: -pre-wrap; /* Opera 4-6 */ - white-space: -o-pre-wrap; /* Opera 7 */ - white-space: pre-wrap; /* CSS3 */ - word-wrap: break-word; /* IE 5.5+ */ - } -} - - - - -/* - wxWidgets docs specific styles - ============================== -*/ - -img.logo { - float: right; - margin: 20px; -} - -img.appearance { - margin: 20px; -} - -table.appearance { - width: 100%; - text-align: center; - font-style: italic; - font-size: 90%; - /*font-weight: bold;*/ -} - -td.green { color: green; } -td.orange { color: #ff8000; } -td.red { color: red; } - -span.literal { - text-decoration: none; - font-weight: bold; - font-family: monospace, fixed; -} - -/* we make all the following tags render the text just like - the standard Doxygen @remarks, @see tags do, to obtain a uniform - look and feel */ -span.itemdef, span.lib, span.category, span.stdobj, span.styles, -span.events, span.flags, span.appearance, span.impl, span.avail { - font-weight: bold; - line-height: 130%; -} - -span.style, span.event, span.flag { - font-weight: bold; - color: #880000; -} - -div.styleDesc, div.eventDesc, div.flagDesc { - margin-left: 3%; - margin-bottom: 1ex; -} - -div.eventHandler { - margin: 1em; - text-indent: 3%; -} - -div.eventHandler span { - padding: 5px; - background-color: #eeeeee; - font-family: monospace, fixed; -} - -code { - font-size: 110%; - color: #444444; -} diff --git a/docs/doxygen/extra_stylesheet.css b/docs/doxygen/extra_stylesheet.css new file mode 100644 index 0000000000..48658c3ca8 --- /dev/null +++ b/docs/doxygen/extra_stylesheet.css @@ -0,0 +1,113 @@ +/* wxWidgets Custom Styles */ + +#projectlogo { + text-align: left; + padding: 0.5em; +} + +#projectnumber { + font: 120% Tahoma, Arial, sans-serif; + text-align: right; + padding: 0.5em 1em; +} + +h1, h2, h3, h4, h5, h6 { + color: #002D88; + font-weight: normal; + margin-top: 1em; + margin-bottom: 0.5em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h1 { + font-size: 150%; + border-bottom: 1px solid #3276FF; +} +h2 { + font-size: 135%; + margin-top: 0.75em; +} +h3 { + font-size: 120%; + margin-top: 0.5em; +} +h4 { + font-size: 100%; + margin-top: 0.5em; +} + +img.logo { + float: right; + margin: 20px; +} + +div.appearance { + margin: 1em 0em; +} +div.appearance table { + margin: 0.5em 0em; + width: 100%; + text-align: center; +} +div.appearance img { + margin: 0.5em; +} +div.appearance .caption { + font-style: italic; + font-weight: normal; + font-size: 90%; +} + +td.green { color: green; } +td.orange { color: #ff8000; } +td.red { color: red; } + +span.literal { + text-decoration: none; + font-weight: bold; + font-family: monospace, fixed; +} + +/* we make all the following tags render the text just like + the standard Doxygen @remarks, @see tags do, to obtain a uniform + look and feel */ +span.itemdef, span.lib, span.category, span.stdobj, span.styles, +span.events, span.flags, span.appearance, span.impl, span.avail { + font-weight: bold; + line-height: 130%; +} + +span.style, span.event, span.flag { + font-weight: bold; + color: #880000; +} + +div.styleDesc, div.eventDesc, div.flagDesc { + margin-left: 3%; + margin-bottom: 1ex; +} + +div.eventHandler { + margin: 1em; + text-indent: 3%; +} + +div.eventHandler span { + padding: 5px; + background-color: #eeeeee; + font-family: monospace, fixed; +} + +code { + font-size: 110%; + color: #444444; +} + +hr.footer { + margin-top: 2em; +} +address.footer { + margin: 0.75em; +} \ No newline at end of file -- 2.45.2