]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/Doxyfile
More doxygen overview updates.
[wxWidgets.git] / docs / doxygen / Doxyfile
index a4bec74eeb0fa38a059c64763187dac8a7f55560..63862603c95ce0bc62a74789e827085f71526ada 100644 (file)
@@ -66,6 +66,15 @@ ALIASES += library{1}="\section class_lib Library\n \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"
 
+# 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}
+
+
 # IMPORTANT: the default \sa command does not generate a \section!
 ALIASES += seealso="\section class_sa See also\n"
 
@@ -82,12 +91,12 @@ ALIASES += true="<b><tt>true</tt></b>"
 ALIASES += false="<b><tt>false</tt></b>"
 ALIASES += NULL="<b><tt>NULL</tt></b>"
 
-# NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, 
+# 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'>"
-ALIASES += beginInvisibleTable="<center><table class='doctable' border='0'>"
+ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
+ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
@@ -140,6 +149,11 @@ ALIASES += endWxPerlOnly="\endif"
 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n <b>wxPython note</b>\n\n"
 ALIASES += endWxPythonOnly="\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="}"
+
 
 #---------------------------------------------------------------------------
 # Build related configuration options