]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/Doxyfile_inc
Fixed docs footer to bottom, and fixed up TOC on all main pages, and some overviews.
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
index 6acb0074f8ad9a53ff20590f7e91f85fbb53cd83..4a9b81d505be82609fa8243e6b9733ddafd875ae 100644 (file)
@@ -3,7 +3,7 @@
 ## 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
-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
@@ -83,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 += 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
@@ -180,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"
-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.
@@ -192,8 +206,8 @@ ALIASES += rightCurly="}"
 # 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
@@ -307,30 +321,55 @@ IGNORE_PREFIX          = wx
 GENERATE_HTML          = NO # Only change in format output configs
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = htmlheader.inc
-HTML_FOOTER            = htmlfooter.inc
-HTML_STYLESHEET        =
+HTML_HEADER            = custom_header.html
+HTML_FOOTER            = custom_footer.html
+HTML_STYLESHEET        = custom_stylesheet.css
+HTML_EXTRA_FILES       = jquery-1.3.2.min.js
+HTML_COLORSTYLE_HUE    =
+HTML_COLORSTYLE_SAT    = 255
+HTML_COLORSTYLE_GAMMA  = 100
+HTML_TIMESTAMP         = YES
 HTML_ALIGN_MEMBERS     = YES
 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_QHP           = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Qt Help Project output
+#---------------------------------------------------------------------------
+
+GENERATE_QHP           = NO # Only change in format output configs
 QCH_FILE               =
 QHP_NAMESPACE          = org.wxwidgets.doxygen
 QHP_VIRTUAL_FOLDER     = doc
 QHG_LOCATION           =
-DISABLE_INDEX          = NO
-ENUM_VALUES_PER_LINE   = 1
-GENERATE_TREEVIEW      = NONE
-TREEVIEW_WIDTH         = 250
-FORMULA_FONTSIZE       = 10
+
+#---------------------------------------------------------------------------
+# 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