Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

use CSS spans instead of \sections so that we uniform the look to the Doxygen HTML for @see tag; remove @seealso and rather use the std @see tag

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52423 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-10 15:11:37 +00:00
parent 626b09ec05
commit e1ebc6f432
2 changed files with 58 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/doxygen/Doxyfile.inc
View File

@@ -47,52 +47,55 @@ SUBGROUPING = YES
# us to keep the headers readable and "implement" wxWidgets-specific commands. # us to keep the headers readable and "implement" wxWidgets-specific commands.
# event aliases # event aliases
ALIASES = beginEventTable="\section class_events Events\n" ALIASES = beginEventTable="<div><span class='events'>Events:</span>"
ALIASES += event{1}="\li <span class='event'>\1</span>" ALIASES += event{1}="\li <span class='event'>\1</span>"
ALIASES += event{2}="\li <span class='event'>\1, \2</span>" ALIASES += event{2}="\li <span class='event'>\1, \2</span>"
ALIASES += event{3}="\li <span class='event'>\1, \2, \3</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 += event{4}="\li <span class='event'>\1, \2, \3, \4</span>"
ALIASES += endEventTable="\n" ALIASES += endEventTable="</div>"
# style aliases # style aliases
ALIASES += beginStyleTable="\section class_styles Styles\n" ALIASES += beginStyleTable="<div><span class='styles'>Styles:</span>"
ALIASES += style{1}="\li <span class='style'>\1</span>" ALIASES += style{1}="\li <span class='style'>\1</span>"
ALIASES += endStyleTable="\n" ALIASES += endStyleTable="</div>"
# extra style aliases # extra style aliases
ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n" ALIASES += beginExtraStyleTable="<div><span class='styles'>Extra styles:</span>"
ALIASES += endExtraStyleTable="\n" ALIASES += endExtraStyleTable="</div>"
# aliases for additional wx-specific infos # aliases for additional wx-specific infos
ALIASES += library{1}="\section class_lib Library\n Belongs to library \ref page_libs_\1." ALIASES += category{1}="<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref page_class_cat_\1</span></div>"
ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based." ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
ALIASES += stdobjects="\section class_stdobj Predefined objects\n" ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
ALIASES += category{1}="\section class_category Category\n \ref page_class_cat_\1" ALIASES += stdobjects="<span class='stdobj'>Predefined objects:</span>"
# aliases with references to wxWidgets ports # native implementation infos:
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{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native implementations are used for \ref page_port_\1 port; generic implementation is used elsewhere.</div>"
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{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native implementations are used for \ref page_port_\1, \ref page_port_\2 ports; generic implementation is used elsewhere.</div>"
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{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; generic implementation is used elsewhere.</div>"
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 += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;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.</div>"
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." # onlyfor infos:
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{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div>"
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." ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div>"
ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div>"
ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div>"
# creates appearance section: this should be used for all main GUI controls # 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" ALIASES += appearance{1}="@htmlonly <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"
# IMPORTANT: the default \sa command does not generate a \section!
ALIASES += seealso="\section class_sa See also\n"
# IMPORTANT: the \headerfile command does not work everywhere we'd need it, # 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 # 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.... # 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 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
# and not twice as the \headerfile command requires (and thus we use @wxheader)
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" 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 # some formatting aliases
ALIASES += true="<span class='literal'>true</span>" ALIASES += true="<span class='literal'>true</span>"
ALIASES += false="<span class='literal'>false</span>" ALIASES += false="<span class='literal'>false</span>"

38
docs/doxygen/wxwidgets.css
View File

@@ -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 { BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
font-family: Geneva, Arial, Helvetica, sans-serif; font-family: Geneva, Arial, Helvetica, sans-serif;
} }
@@ -7,7 +22,7 @@ BODY,TD {
H1 { H1 {
text-align: center; text-align: center;
font-size: 160%; font-size: 160%;
border-top: 1em; border-top: 1em;
} }
H2 { H2 {
font-size: 120%; font-size: 120%;
@@ -435,7 +450,8 @@ HR {
/* /*
wxWidgets docs specific styles wxWidgets docs specific styles
==============================
*/ */
IMG.logo { IMG.logo {
@@ -462,18 +478,18 @@ SPAN.literal {
color: #008800; color: #008800;
} }
SPAN.itemdef { /* we make all the following <span> 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; font-weight: bold;
color: #880000; color: #880000;
} }
SPAN.style {
font-weight: bold;
color: #880000;
}
SPAN.event {
font-weight: bold;
color: #880000;
}