Globally use "wxWindows licence" consistently.

[wxWidgets.git] / docs / doxygen / Doxyfile_inc

diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc
index 6735ab7b00c6a602a6cccc78d240069ebfbbdfe3..c0ae96e50c8e42a8c77d6353a981f3bea5774df7 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,7 @@
 
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = wxWidgets
 
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = wxWidgets

-PROJECT_NUMBER         = 2.9.0
+PROJECT_NUMBER         = 2.9.1

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


@@ -83,7 +83,18 @@ 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"
+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 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


@@ -192,8 +203,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/\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


@@ -441,7 +452,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


@@ -450,6 +460,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
 #---------------------------------------------------------------------------