Documentation screenshot generator source code cleanup.

[wxWidgets.git] / docs / doxygen / Doxyfile_inc

diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc
index 8afbd597c60ae5a563dfe81ab1e394db6b3c348d..4a9b81d505be82609fa8243e6b9733ddafd875ae 100644 (file)
--- a/docs/doxygen/Doxyfile_inc
+++ b/docs/doxygen/Doxyfile_inc
@@ -3,7 +3,7 @@
 ## Purpose:     Main configuration file for the wxWidgets manual
 ## Author:      Francesco Montorsi
 ## RCS-ID:      $Id$
 ## Purpose:     Main configuration file for the wxWidgets manual
 ## Author:      Francesco Montorsi
 ## RCS-ID:      $Id$

-## Licence:     wxWindows license
+## Licence:     wxWindows licence

 #############################################################################
 
 #---------------------------------------------------------------------------
 #############################################################################
 
 #---------------------------------------------------------------------------


@@ -12,7 +12,9 @@
 
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = wxWidgets
 
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = wxWidgets

-PROJECT_NUMBER         = 2.9.0
+PROJECT_NUMBER         = 2.9.5
+PROJECT_BRIEF          =
+PROJECT_LOGO           = logo.png

 OUTPUT_DIRECTORY       = out
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 OUTPUT_DIRECTORY       = out
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English


@@ -52,9 +54,16 @@ SYMBOL_CACHE_SIZE      = 0
 # Aliases - for use when documenting C++ classes
 #---------------------------------------------------------------------------
 
 # Aliases - for use when documenting C++ classes
 #---------------------------------------------------------------------------
 

-# event aliases
-ALIASES = beginEventTable{1}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
-ALIASES += beginEventTable{2}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
+# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
+ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
+ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
+ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
+
+# aliases to be used in wxEvent-derived classes:
+ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
+ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
+
+# common event aliases:

 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"


@@ -76,7 +85,21 @@ ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'
 ALIASES += endFlagTable="</div>\n"
 
 # creates appearance section: this should be used for all main GUI controls
 ALIASES += endFlagTable="</div>\n"
 
 # creates appearance section: this should be used for all main GUI controls

-ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
+# that look different in different ports. genericAppearance can be used for the
+# controls that always look the same.
+ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'/></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'/></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'/></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
+ALIASES += genericAppearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='generic/\1' alt='Generic appearance' class='appearance'/></td></tr></table></div> \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}="<a name='\1'></a> \name \2"
+ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
+

 
 #---------------------------------------------------------------------------
 # Aliases - for use when documenting any C++ entity
 
 #---------------------------------------------------------------------------
 # Aliases - for use when documenting any C++ entity


@@ -85,6 +108,7 @@ ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance
 # aliases for additional wx-specific infos
 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
 # aliases for additional wx-specific infos
 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"

+ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"

 ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
 ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
 ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
 ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"


@@ -172,8 +196,6 @@ ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image ht
 # See ENABLED_SECTIONS configuration key for more info about these:
 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
 ALIASES += endWxPerlOnly="\endif"
 # See ENABLED_SECTIONS configuration key for more info about these:
 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
 ALIASES += endWxPerlOnly="\endif"

-ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
-ALIASES += endWxPythonOnly="\endif"

 
 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
 # inside of any aliased command in parameters.
 
 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
 # inside of any aliased command in parameters.


@@ -184,8 +206,8 @@ ALIASES += rightCurly="}"
 # Aliases - for use when documenting samples
 #---------------------------------------------------------------------------
 
 # Aliases - for use when documenting samples
 #---------------------------------------------------------------------------
 

-# For indicating the a directory containing a sample
-ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
+# For indicating a sample location
+ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"

 
 # For refering to the corresponding sample in a class document or a overview
 # Usually placed in the queue of @see
 
 # For refering to the corresponding sample in a class document or a overview
 # Usually placed in the queue of @see


@@ -299,30 +321,55 @@ IGNORE_PREFIX          = wx
 GENERATE_HTML          = NO # Only change in format output configs
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
 GENERATE_HTML          = NO # Only change in format output configs
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html

-HTML_HEADER            = htmlheader.inc
-HTML_FOOTER            = htmlfooter.inc
-HTML_STYLESHEET        =
+HTML_HEADER            = custom_header.html
+HTML_FOOTER            = custom_footer.html
+HTML_STYLESHEET        = custom_stylesheet.css
+HTML_EXTRA_FILES       = jquery-1.3.2.min.js
+HTML_COLORSTYLE_HUE    =
+HTML_COLORSTYLE_SAT    = 255
+HTML_COLORSTYLE_GAMMA  = 100
+HTML_TIMESTAMP         = YES

 HTML_ALIGN_MEMBERS     = YES
 HTML_DYNAMIC_SECTIONS  = YES
 HTML_ALIGN_MEMBERS     = YES
 HTML_DYNAMIC_SECTIONS  = YES

-GENERATE_DOCSET        = NO # Only change in format output configs
-DOCSET_FEEDNAME        = "wxWidgets"
-DOCSET_BUNDLE_ID       = org.wxwidgets.doxygen
+DISABLE_INDEX          = NO
+ENUM_VALUES_PER_LINE   = 1
+GENERATE_TREEVIEW      = NO
+USE_INLINE_TREES       = NO
+TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = YES
+FORMULA_FONTSIZE       = 10
+FORMULA_TRANSPARENT    = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the CHM output
+#---------------------------------------------------------------------------
+

 GENERATE_HTMLHELP      = NO # Only change in format output configs
 CHM_FILE               = ..\wx.chm # NOTE: Windows style separator needed
 HHC_LOCATION           = hhc.exe # Don't modify, see Doxyfile_chm for info
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
 TOC_EXPAND             = NO
 GENERATE_HTMLHELP      = NO # Only change in format output configs
 CHM_FILE               = ..\wx.chm # NOTE: Windows style separator needed
 HHC_LOCATION           = hhc.exe # Don't modify, see Doxyfile_chm for info
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
 TOC_EXPAND             = NO

-GENERATE_QHP           = NO
-QCH_FILE               = 
+
+#---------------------------------------------------------------------------
+# configuration options related to the Qt Help Project output
+#---------------------------------------------------------------------------
+
+GENERATE_QHP           = NO # Only change in format output configs
+QCH_FILE               =

 QHP_NAMESPACE          = org.wxwidgets.doxygen
 QHP_VIRTUAL_FOLDER     = doc
 QHP_NAMESPACE          = org.wxwidgets.doxygen
 QHP_VIRTUAL_FOLDER     = doc

-QHG_LOCATION           = 
-DISABLE_INDEX          = NO
-ENUM_VALUES_PER_LINE   = 1
-GENERATE_TREEVIEW      = NONE
-TREEVIEW_WIDTH         = 250
-FORMULA_FONTSIZE       = 10
+QHG_LOCATION           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the Docset output
+#---------------------------------------------------------------------------
+
+GENERATE_DOCSET        = NO # Only change in format output configs
+DOCSET_FEEDNAME        = "wxWidgets 2.9"
+DOCSET_BUNDLE_ID       = org.wxwidgets.doxygen.wx29
+DOCSET_PUBLISHER_ID    = org.wxwidgets.doxygen
+DOCSET_PUBLISHER_NAME  = wxWidgets Team

 
 #---------------------------------------------------------------------------
 # LaTeX Output Options
 
 #---------------------------------------------------------------------------
 # LaTeX Output Options


@@ -420,7 +467,7 @@ HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
 DOT_FONTNAME           = FreeSans
 DOT_FONTSIZE           = 10
 HAVE_DOT               = YES
 DOT_FONTNAME           = FreeSans
 DOT_FONTSIZE           = 10

-DOT_FONTPATH           = 
+DOT_FONTPATH           =

 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = NO
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = NO


@@ -433,7 +480,6 @@ CALLER_GRAPH           = NO
 GRAPHICAL_HIERARCHY    = NO
 DIRECTORY_GRAPH        = NO
 DOT_IMAGE_FORMAT       = png
 GRAPHICAL_HIERARCHY    = NO
 DIRECTORY_GRAPH        = NO
 DOT_IMAGE_FORMAT       = png

-DOT_PATH               =

 DOTFILE_DIRS           =
 DOT_GRAPH_MAX_NODES    = 50
 MAX_DOT_GRAPH_DEPTH    = 1000
 DOTFILE_DIRS           =
 DOT_GRAPH_MAX_NODES    = 50
 MAX_DOT_GRAPH_DEPTH    = 1000


@@ -442,6 +488,12 @@ DOT_MULTI_TARGETS      = NO
 GENERATE_LEGEND        = YES
 DOT_CLEANUP            = YES
 
 GENERATE_LEGEND        = YES
 DOT_CLEANUP            = YES
 

+# instead of setting a value for DOT_PATH it's easier and more portable to
+# put your dot utility in the PATH; if you are on a Unix system this is usually
+# done automatically; if you're on Windows you'll need to install GraphViz tools
+# and then manually add it to the PATH environment variable
+DOT_PATH               =
+

 #---------------------------------------------------------------------------
 # Search Engine Options
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # Search Engine Options
 #---------------------------------------------------------------------------