]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/Doxyfile.inc
remove spurious \b
[wxWidgets.git] / docs / doxygen / Doxyfile.inc
index e64a21f9aeacff6b17515563323057cd4d9a0fdc..82a734ee94583bafe0b29e8f32ee2e396550b1e7 100644 (file)
@@ -36,7 +36,7 @@ OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
 BUILTIN_STL_SUPPORT    = NO
 CPP_CLI_SUPPORT        = NO
-DISTRIBUTE_GROUP_DOC   = NO
+DISTRIBUTE_GROUP_DOC   = YES
 SUBGROUPING            = YES
 
 #---------------------------------------------------------------------------
@@ -48,13 +48,15 @@ SUBGROUPING            = YES
 
 # event aliases
 ALIASES = beginEventTable="\section class_events Events\n"
-ALIASES += event{1}="\li \b <tt>\1</tt>"
-ALIASES += event{2}="\li \b <tt>\1, \2</tt>"
+ALIASES += event{1}="\li <span class='event'>\1</span>"
+ALIASES += event{2}="\li <span class='event'>\1, \2</span>"
+ALIASES += event{3}="\li <span class='event'>\1, \2, \3</span>"
+ALIASES += event{4}="\li <span class='event'>\1, \2, \3, \4</span>"
 ALIASES += endEventTable="\n"
 
 # style aliases
 ALIASES += beginStyleTable="\section class_styles Styles\n"
-ALIASES += style{1}="\li \b \c \1"
+ALIASES += style{1}="\li <span class='style'>\1</span>"
 ALIASES += endStyleTable="\n"
 
 # extra style aliases
@@ -62,23 +64,23 @@ ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n"
 ALIASES += endExtraStyleTable="\n"
 
 # aliases for additional wx-specific infos 
-ALIASES += library{1}="\section class_lib Library\n \ref page_libs_\1"
+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 += category{1}="\section class_category Category\n"
+ALIASES += stdobjects="\section class_stdobj Predefined objects\n"
+ALIASES += category{1}="\section class_category Category\n \ref page_class_cat_\1"
 
 # aliases with references to wxWidgets ports
-ALIASES += nativeimpl{1}="\section class_impl Native implementations\n \ref page_port_\1"
-ALIASES += nativeimpl{2}="\section class_impl Native implementations\n \ref page_port_\1, \ref page_port_\2"
-ALIASES += nativeimpl{3}="\section class_impl Native implementations\n \ref page_port_\1, \ref page_port_\2, \ref page_port_\3"
-ALIASES += nativeimpl{4}="\section class_impl Native implementations\n \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4"
-ALIASES += onlyfor{1}="\section class_onlyfor Only available for\n \ref page_port_\1"
-ALIASES += onlyfor{2}="\section class_onlyfor Only available for\n \ref page_port_\1, \ref page_port_\2"
-ALIASES += onlyfor{3}="\section class_onlyfor Only available for\n \ref page_port_\1, \ref page_port_\2, \ref page_port_\3"
-ALIASES += onlyfor{4}="\section class_onlyfor Only available for\n \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4"
+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 <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"
+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"
@@ -86,15 +88,25 @@ 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....
+#            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 += 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
-#       \c gets applied to the first word following and \b to the second word following;
-#       we want both bold and typetext attributes to be applied to the same word!
-ALIASES += true="<b><tt>true</tt></b>"
-ALIASES += false="<b><tt>false</tt></b>"
-ALIASES += NULL="<b><tt>NULL</tt></b>"
+ALIASES += true="<span class='literal'>true</span>"
+ALIASES += false="<span class='literal'>false</span>"
+ALIASES += NULL="<span class='literal'>NULL</span>"
+
+# 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
+ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
+ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
+ALIASES += if_="<span class='literal'>\#if</span>"
+ALIASES += endif_="<span class='literal'>\#endif</span>"
 
 # table aliases for 2 and 3 column tables
 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
@@ -125,27 +137,17 @@ ALIASES += endTable="</table></center>"
 # nature and because it is always the association of a "title" with a "description"
 # (in contrast a table may have more than 2 columns of data)...
 ALIASES += beginDefList="<table class='doclist'>"
-ALIASES += itemdef{2}="<tr><td>\b \1</td> <td>\2</td></tr>"
-ALIASES += itemdef{3}="<tr><td>\b \1</td> <td>\2,\3</td></tr>"
-ALIASES += itemdef{4}="<tr><td>\b \1</td> <td>\2,\3,\4</td></tr>"
-ALIASES += itemdef{5}="<tr><td>\b \1</td> <td>\2,\3,\4,\5</td></tr>"
-ALIASES += itemdef{6}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6</td></tr>"
-ALIASES += itemdef{7}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
-ALIASES += itemdef{8}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
-ALIASES += itemdef{9}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
-ALIASES += itemdef{10}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
+ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
+ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
+ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
+ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
+ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
+ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
+ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
+ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
+ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 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!
-#       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 += endif_="<b><tt>\#endif</tt></b>"
-
 # See ENABLED_SECTIONS configuration key for more info about these:
 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n <b>wxPerl note</b>\n\n"
 ALIASES += endWxPerlOnly="\endif"
@@ -167,8 +169,8 @@ EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
 EXTRACT_LOCAL_METHODS  = NO
 EXTRACT_ANON_NSPACES   = YES
-HIDE_UNDOC_MEMBERS     = YES
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
 HIDE_FRIEND_COMPOUNDS  = NO
 HIDE_IN_BODY_DOCS      = NO
 INTERNAL_DOCS          = NO
@@ -177,7 +179,7 @@ HIDE_SCOPE_NAMES       = NO
 SHOW_INCLUDE_FILES     = YES
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
-SORT_BRIEF_DOCS        = YES
+SORT_BRIEF_DOCS        = NO     # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
 SORT_BY_SCOPE_NAME     = NO
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
@@ -189,7 +191,7 @@ ENABLED_SECTIONS       =
 
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 FILE_VERSION_FILTER    = 
 
 #---------------------------------------------------------------------------
@@ -197,9 +199,9 @@ FILE_VERSION_FILTER    =
 #---------------------------------------------------------------------------
 QUIET                  = NO
 WARNINGS               = YES
-WARN_IF_UNDOCUMENTED   = NO
+WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 WARN_FORMAT            = "$file:$line: $text   "
 WARN_LOGFILE           = doxygen.log
 
@@ -269,10 +271,10 @@ MAKEINDEX_CMD_NAME     = makeindex
 COMPACT_LATEX          = NO
 PAPER_TYPE             = a4wide
 EXTRA_PACKAGES         = 
-LATEX_HEADER           = 
-PDF_HYPERLINKS         = NO
-USE_PDFLATEX           = NO
-LATEX_BATCHMODE        = NO
+LATEX_HEADER           = latexdocstart.inc
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = YES
 LATEX_HIDE_INDICES     = NO
 
 #---------------------------------------------------------------------------