AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added class groups example to Doxygen and added parent "Functions and Macros", and "Classes by Category" groups.

Browse Source 
Also added CSS to add "Categories / " to the "Modules" tab label, and turned on DETAILS_AT_TOP setting.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52454 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty 2008-03-12 19:08:48 +00:00
parent dd9f8b6bb6
commit 3db7c3b1aa
23 changed files with 102 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/Doxyfile.inc
View File

@ -28,7 +28,7 @@ SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
DETAILS_AT_TOP = YES
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4

16
docs/doxygen/groups/class.h Normal file
View File

@ -0,0 +1,16 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class.h
// Purpose: Main class group docs
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class Classes by Category
This group defines all class groups.
*/

21
docs/doxygen/groups/class_dc.h Normal file
View File

@ -0,0 +1,21 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_gdi.h
// Purpose: Graphics Device Interface classes group docs
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_dc Device Contexts
@ingroup group_class
Device contexts are surfaces that may be drawn on, and provide an abstraction
that allows parameterisation of your drawing code by passing different device
contexts.
Related Overviews: @ref overview_dc
*/

20
docs/doxygen/groups/class_gdi.h Normal file
View File

@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_gdi.h
// Purpose: Graphics Device Interface classes group docs
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_gdi Graphics Device Interface (GDI)
@ingroup group_class
The following are classes related to GDI (Graphics Device Interface) access.
They provide an API for drawing on device contexts, windows, and printing.
Related Overviews: @ref overview_dc, @ref overview_bitmap
*/

16
docs/doxygen/groups/funcmacro.h Normal file
View File

@ -0,0 +1,16 @@
/////////////////////////////////////////////////////////////////////////////
// Name: funcmacro.h
// Purpose: Main function and macro group docs
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_funcmacro Functions and Macros
This group defines all major function and macro groups.
*/

7
docs/doxygen/groups/gdi.h → docs/doxygen/groups/funcmacro_gdi.h
View File

@ -1,14 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: gdi.h
// Name: funcmacro_gdi.h
// Purpose: Graphics Device Interface function and macro docs
// Author: wxWidgets team
// RCS-ID: $Id: gdicmn.h 52425 2008-03-10 15:24:38Z FM $
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_gdi Graphics Device Interface (GDI) Functions and Macros
@defgroup group_funcmacro_gdi Graphics Device Interface (GDI)
@ingroup group_funcmacro
The following are functions and macros related to GDI (Graphics Device
Interface) access.

4
docs/doxygen/wxwidgets.css
View File

@ -491,5 +491,7 @@ SPAN.style, SPAN.event {
color: #880000;
}
A[HREF="modules.html"] SPAN:before {
content: "Categories / ";
}

1
interface/animate.h
View File

@ -170,6 +170,7 @@ public:
/**
@class wxAnimation
@ingroup group_class_gdi
@wxheader{animate.h}
This class encapsulates the concept of a platform-dependent animation.

2
interface/bitmap.h
View File

@ -147,6 +147,7 @@ public:
/**
@class wxBitmap
@ingroup group_class_gdi
@wxheader{bitmap.h}
This class encapsulates the concept of a platform-dependent bitmap,
@ -724,6 +725,7 @@ wxBitmap wxNullBitmap;
/**
@class wxMask
@ingroup group_class_gdi
@wxheader{bitmap.h}
This class encapsulates a monochrome mask bitmap, where the masked area is

1
interface/brush.h
View File

@ -8,6 +8,7 @@
/**
@class wxBrush
@ingroup group_class_gdi
@wxheader{brush.h}
A brush is a drawing tool for filling in areas. It is used for painting

1
interface/colour.h
View File

@ -8,6 +8,7 @@
/**
@class wxColour
@ingroup group_class_gdi
@wxheader{colour.h}
A colour is an object representing a combination of Red, Green, and Blue (RGB)

1
interface/cursor.h
View File

@ -8,6 +8,7 @@
/**
@class wxCursor
@ingroup group_class_gdi
@wxheader{cursor.h}
A cursor is a small bitmap usually used for denoting where the mouse

2
interface/dc.h
View File

@ -8,6 +8,7 @@
/**
@class wxDC
@ingroup group_class_dc group_class_gdi
@wxheader{dc.h}
A wxDC is a @e device context onto which graphics and text can be drawn.
@ -977,6 +978,7 @@ public:
/**
@class wxDCClipper
@ingroup group_class_gdi
@wxheader{dc.h}
wxDCClipper is a small helper class for setting a clipping region on a

1
interface/font.h
View File

@ -8,6 +8,7 @@
/**
@class wxFont
@ingroup group_class_gdi
@wxheader{font.h}
A font is an object which determines the appearance of text. Fonts are

5
interface/gdicmn.h
View File

@ -326,6 +326,7 @@ public:
/**
@class wxBrushList
@ingroup group_class_gdi
@wxheader{gdicmn.h}
A brush list is a list containing all brushes which have been created.
@ -476,6 +477,7 @@ public:
/**
@class wxFontList
@ingroup group_class_gdi
@wxheader{gdicmn.h}
A font list is a list containing all fonts which have been created. There
@ -668,6 +670,7 @@ public:
/**
@class wxPenList
@ingroup group_class_gdi
@wxheader{gdicmn.h}
There is only one instance of this class: @b wxThePenList. Use
@ -739,7 +742,7 @@ public:
// Global functions/macros
// ============================================================================
/** @addtogroup group_gdi */
/** @ingroup group_funcmacro_gdi */
//@{
/**

1
interface/icon.h
View File

@ -8,6 +8,7 @@
/**
@class wxIcon
@ingroup group_class_gdi
@wxheader{icon.h}
An icon is a small rectangular bitmap usually used for denoting a

1
interface/image.h
View File

@ -139,6 +139,7 @@ public:
/**
@class wxImage
@ingroup group_class_gdi
@wxheader{image.h}
This class encapsulates a platform-independent image. An image can be created

1
interface/imaglist.h
View File

@ -8,6 +8,7 @@
/**
@class wxImageList
@ingroup group_class_gdi
@wxheader{imaglist.h}
A wxImageList contains a list of images, which are stored in

2
interface/metafile.h
View File

@ -117,7 +117,7 @@ public:
// Global functions/macros
// ============================================================================
/** @addtogroup group_gdi */
/** @ingroup group_funcmacro_gdi */
//@{
/**

1
interface/palette.h
View File

@ -8,6 +8,7 @@
/**
@class wxPalette
@ingroup group_class_gdi
@wxheader{palette.h}
A palette is a table that maps pixel values to RGB colours. It allows the

1
interface/pen.h
View File

@ -8,6 +8,7 @@
/**
@class wxPen
@ingroup group_class_gdi
@wxheader{pen.h}
A pen is a drawing tool for drawing outlines. It is used for drawing

1
interface/region.h
View File

@ -99,6 +99,7 @@ public:
/**
@class wxRegion
@ingroup group_class_gdi
@wxheader{region.h}
A wxRegion represents a simple or complex region on a device context or window.

1
interface/renderer.h
View File

@ -100,6 +100,7 @@ public:
/**
@class wxRendererNative
@ingroup group_class_gdi
@wxheader{renderer.h}
First, a brief introduction to wxRenderer and why it is needed.