diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc index 82a734ee94..0f80a2e9ac 100644 --- a/docs/doxygen/Doxyfile.inc +++ b/docs/doxygen/Doxyfile.inc @@ -47,52 +47,55 @@ SUBGROUPING = YES # us to keep the headers readable and "implement" wxWidgets-specific commands. # event aliases -ALIASES = beginEventTable="\section class_events Events\n" +ALIASES = beginEventTable="
Events:" ALIASES += event{1}="\li \1" ALIASES += event{2}="\li \1, \2" ALIASES += event{3}="\li \1, \2, \3" ALIASES += event{4}="\li \1, \2, \3, \4" -ALIASES += endEventTable="\n" +ALIASES += endEventTable="
" # style aliases -ALIASES += beginStyleTable="\section class_styles Styles\n" +ALIASES += beginStyleTable="
Styles:" ALIASES += style{1}="\li \1" -ALIASES += endStyleTable="\n" +ALIASES += endStyleTable="
" # extra style aliases -ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n" -ALIASES += endExtraStyleTable="\n" +ALIASES += beginExtraStyleTable="
Extra styles:" +ALIASES += endExtraStyleTable="
" -# 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" -ALIASES += category{1}="\section class_category Category\n \ref page_class_cat_\1" +# aliases for additional wx-specific infos +ALIASES += category{1}="
Category:  \ref page_class_cat_\1
" +ALIASES += library{1}="
Library:  \ref page_libs_\1
" +ALIASES += nolibrary="
Library:  None; this class implementation is entirely header-based.
" +ALIASES += stdobjects="Predefined objects:" -# 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." +# native implementation infos: +ALIASES += nativeimpl{1}="
Implementations:  native implementations are used for \ref page_port_\1 port; generic implementation is used elsewhere.
" +ALIASES += nativeimpl{2}="
Implementations:  native implementations are used for \ref page_port_\1, \ref page_port_\2 ports; generic implementation is used elsewhere.
" +ALIASES += nativeimpl{3}="
Implementations:  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}="
Implementations:  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.
" + +# onlyfor infos: +ALIASES += onlyfor{1}="
Availability:  only available for the \ref page_port_\1 port.
" +ALIASES += onlyfor{2}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2 ports.
" +ALIASES += onlyfor{3}="
Availability:  only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.
" +ALIASES += onlyfor{4}="
Availability:  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:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" - -# IMPORTANT: the default \sa command does not generate a \section! -ALIASES += seealso="\section class_sa See also\n" +ALIASES += appearance{1}="@htmlonly
Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance
@endhtmlonly" # 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" +# even if they're not inside a \class, \function or \struct command: +ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim" + +# IMPORTANT: inside a \class, we want to specify the header file only once +# and not twice as the \headerfile command requires: ALIASES += wxheader{1}="\headerfile \1 wx/\1" +# the following alias avoids to repeat lots of times the same statement: +ALIASES += wxsince{1}="\since This function is new since wxWidgets version \1." + # some formatting aliases ALIASES += true="true" ALIASES += false="false" diff --git a/docs/doxygen/wxwidgets.css b/docs/doxygen/wxwidgets.css index 409b0c148e..150d949d6a 100644 --- a/docs/doxygen/wxwidgets.css +++ b/docs/doxygen/wxwidgets.css @@ -1,3 +1,18 @@ +/***************************************************************************** + ** Name: wxwidgets.css + ** Purpose: The wxWidgets documentation CSS; a customized version of + ** the standard Doxygen CSS + ** Author: Doxygen team + ** RCS-ID: $Id$ + ** Licence: wxWindows license + *****************************************************************************/ + + +/* + Doxygen classic styles + ====================== +*/ + BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { font-family: Geneva, Arial, Helvetica, sans-serif; } @@ -7,7 +22,7 @@ BODY,TD { H1 { text-align: center; font-size: 160%; - border-top: 1em; + border-top: 1em; } H2 { font-size: 120%; @@ -435,7 +450,8 @@ HR { /* - wxWidgets docs specific styles + wxWidgets docs specific styles + ============================== */ IMG.logo { @@ -462,18 +478,18 @@ SPAN.literal { color: #008800; } -SPAN.itemdef { +/* we make all the following tags render the text just like + the standard Doxygen @remarks, @see tags do, to obtain a uniform + look and feel */ +SPAN.itemdef, SPAN.lib, SPAN.category, SPAN.stdobj, SPAN.styles, SPAN.events, SPAN.appearance, SPAN.impl, SPAN.avail { + font-weight: bold; + line-height: 130%; +} + +SPAN.style, SPAN.event { font-weight: bold; color: #880000; } -SPAN.style { - font-weight: bold; - color: #880000; -} -SPAN.event { - font-weight: bold; - color: #880000; -}