deprecated wxWindow::SetHelpTextForId()

[wxWidgets.git] / docs / doxygen / Doxyfile.inc

diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc
index c441c0dd00c79864e243058d7842e94c332d1bd6..6c72a4082dd5f2e29ffe382ec67bc4a2eb9b9fca 100644 (file)
--- a/docs/doxygen/Doxyfile.inc
+++ b/docs/doxygen/Doxyfile.inc
@@ -61,19 +61,24 @@ ALIASES += endStyleTable="\n"
 ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n"
 ALIASES += endExtraStyleTable="\n"
 
 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 for additional wx-specific infos 
+ALIASES += library{1}="\section class_lib Library\n Belongs to library \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"
 ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based."
 ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b"

+ALIASES += category{1}="\section class_category Category\n \1"

 
 

-# 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}
+# aliases with references to wxWidgets ports
+ALIASES += nativeimpl{1}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1 port; generic implementation is used elsewhere."
+ALIASES += nativeimpl{2}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2 ports; generic implementation is used elsewhere."
+ALIASES += nativeimpl{3}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; generic implementation is used elsewhere."
+ALIASES += nativeimpl{4}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; generic implementation is used elsewhere."
+ALIASES += onlyfor{1}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1 port."
+ALIASES += onlyfor{2}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2 ports."
+ALIASES += onlyfor{3}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports."
+ALIASES += onlyfor{4}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports."

 
 

+# creates appearance section: this should be used for all main GUI controls
+ALIASES += appearance{1}="\section class_appearance Appearance\n @htmlonly Screenshots for this widget: <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> @endhtmlonly"

 
 # IMPORTANT: the default \sa command does not generate a \section!
 ALIASES += seealso="\section class_sa See also\n"
 
 # IMPORTANT: the default \sa command does not generate a \section!
 ALIASES += seealso="\section class_sa See also\n"


@@ -81,7 +86,10 @@ 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....
 # 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....

+#            and also inside a \class, we want to specify the header file only once
+#            and not twice as the \headerfile command requires (and thus we use @wxheader)

 ALIASES += header{1}="Include file:\n \verbatim #include <\1> @endverbatim"
 ALIASES += header{1}="Include file:\n \verbatim #include <\1> @endverbatim"

+ALIASES += wxheader{1}="\headerfile \1 wx/\1"

 
 # some formatting aliases
 # NOTE: using <b> and <tt> tags is different from using \c \b because in the last case
 
 # some formatting aliases
 # NOTE: using <b> and <tt> tags is different from using \c \b because in the last case


@@ -91,9 +99,6 @@ ALIASES += true="<b><tt>true</tt></b>"
 ALIASES += false="<b><tt>false</tt></b>"
 ALIASES += NULL="<b><tt>NULL</tt></b>"
 
 ALIASES += false="<b><tt>false</tt></b>"
 ALIASES += NULL="<b><tt>NULL</tt></b>"
 

-# 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="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
 # table aliases for 2 and 3 column tables
 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"


@@ -137,7 +142,8 @@ ALIASES += endDefList="</table>"
 # 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!
 # 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
+#       However to avoid overwriting e.g. \if Doxygen command the _
+#       character is postfixed

 ALIASES += ifdef_="<b><tt>\#ifdef</tt></b>"
 ALIASES += ifndef_="<b><tt>\#ifndef</tt></b>"
 ALIASES += if_="<b><tt>\#if</tt></b>"
 ALIASES += ifdef_="<b><tt>\#ifdef</tt></b>"
 ALIASES += ifndef_="<b><tt>\#ifndef</tt></b>"
 ALIASES += if_="<b><tt>\#if</tt></b>"


@@ -203,7 +209,7 @@ WARN_LOGFILE           = doxygen.log
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------

-INPUT                  = ./mainpages ./overviews # ../../interface
+INPUT                  = ./mainpages ./overviews #../../interface

 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h *.txt
 RECURSIVE              = YES
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h *.txt
 RECURSIVE              = YES