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

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

diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc
index 976b624fa218e3e3f64da7c3ffb47ea8d9ed3257..3bcd62e4fc9796360933fe737b8384794d58c880 100644 (file)
--- a/docs/doxygen/Doxyfile.inc
+++ b/docs/doxygen/Doxyfile.inc
@@ -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

diff --git a/docs/doxygen/groups/class.h b/docs/doxygen/groups/class.h
new file mode 100644 (file)
index 0000000..23bd8e9
--- /dev/null
+++ b/docs/doxygen/groups/class.h
@@ -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.
+
+*/
+

diff --git a/docs/doxygen/groups/class_dc.h b/docs/doxygen/groups/class_dc.h
new file mode 100644 (file)
index 0000000..8bcdd49
--- /dev/null
+++ b/docs/doxygen/groups/class_dc.h
@@ -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
+
+*/
+

diff --git a/docs/doxygen/groups/class_gdi.h b/docs/doxygen/groups/class_gdi.h
new file mode 100644 (file)
index 0000000..870e212
--- /dev/null
+++ b/docs/doxygen/groups/class_gdi.h
@@ -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
+
+*/
+

diff --git a/docs/doxygen/groups/funcmacro.h b/docs/doxygen/groups/funcmacro.h
new file mode 100644 (file)
index 0000000..f077fbf
--- /dev/null
+++ b/docs/doxygen/groups/funcmacro.h
@@ -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.
+
+*/
+

diff --git a/docs/doxygen/groups/funcmacro_gdi.h b/docs/doxygen/groups/funcmacro_gdi.h
new file mode 100644 (file)
index 0000000..d7cda14
--- /dev/null
+++ b/docs/doxygen/groups/funcmacro_gdi.h
@@ -0,0 +1,22 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        funcmacro_gdi.h
+// Purpose:     Graphics Device Interface function and macro docs
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_funcmacro_gdi Graphics Device Interface (GDI)
+@ingroup group_funcmacro
+
+The following are functions and macros related to GDI (Graphics Device
+Interface) access.
+
+Related Overviews: @ref overview_dc
+
+@header{wx/gdicmn.h}
+
+*/
+

diff --git a/docs/doxygen/groups/gdi.h b/docs/doxygen/groups/gdi.h
deleted file mode 100644 (file)
index d4abfb6..0000000
--- a/docs/doxygen/groups/gdi.h
+++ /dev/null
@@ -1,21 +0,0 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name:        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 $
-// Licence:     wxWindows license
-/////////////////////////////////////////////////////////////////////////////
-
-/**
-
-@defgroup group_gdi Graphics Device Interface (GDI) Functions and Macros
-
-The following are functions and macros related to GDI (Graphics Device
-Interface) access.
-
-Related Overviews: @ref overview_dc
-
-@header{wx/gdicmn.h}
-
-*/
-

diff --git a/docs/doxygen/wxwidgets.css b/docs/doxygen/wxwidgets.css
index 150d949d6a2340a566c43b7bedb866e4f63756e5..66e848956d5419ba98788826ccc4693c39d518ea 100644 (file)
--- a/docs/doxygen/wxwidgets.css
+++ b/docs/doxygen/wxwidgets.css
@@ -491,5 +491,7 @@ SPAN.style, SPAN.event {
     color: #880000;
 }
 
-
+A[HREF="modules.html"] SPAN:before {
+    content: "Categories / ";
+}
 

diff --git a/interface/animate.h b/interface/animate.h
index 2b66e92db93a029887925bbdf49d84094be0c776..3631671843246a6781b6ef6d3afcc6d1e55bb9c9 100644 (file)
--- a/interface/animate.h
+++ b/interface/animate.h
@@ -170,6 +170,7 @@ public:
 
 /**
     @class wxAnimation
+    @ingroup group_class_gdi
     @wxheader{animate.h}
 
     This class encapsulates the concept of a platform-dependent animation.

diff --git a/interface/bitmap.h b/interface/bitmap.h
index 22710d45ca4b552faa01385e9c4e686a14ce3ff5..fbb889a38c4c598b13488d602a5b69827b5100d7 100644 (file)
--- a/interface/bitmap.h
+++ b/interface/bitmap.h
@@ -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

diff --git a/interface/brush.h b/interface/brush.h
index d644b1e19b5bdfc1136be43b48797c356ae12b87..6b05b82f19979f9b5db2b3129f733158fdf86fc5 100644 (file)
--- a/interface/brush.h
+++ b/interface/brush.h
@@ -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

diff --git a/interface/colour.h b/interface/colour.h
index 9df414c4c7314c474836e128c28e3e657dd4b492..21a03cfd8479ae27dd6a498d1a55dae50c122832 100644 (file)
--- a/interface/colour.h
+++ b/interface/colour.h
@@ -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)

diff --git a/interface/cursor.h b/interface/cursor.h
index ee6fc7ef0ca5921e160eb149b2b95af1302927d2..033cded43f4d526d8ce9f2fa27ada3079d657719 100644 (file)
--- a/interface/cursor.h
+++ b/interface/cursor.h
@@ -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

diff --git a/interface/dc.h b/interface/dc.h
index d1b3b1ad3e4e88629268fc17f52078a25c920167..c48f21fd6cf20f05f32f13b587ff0610373f1f7f 100644 (file)
--- a/interface/dc.h
+++ b/interface/dc.h
@@ -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

diff --git a/interface/font.h b/interface/font.h
index 9f706987b8d5c92124500d99b4a24c8303d0d58f..b76182cefec0e48ea6f2a3c3ddc16661026cce5d 100644 (file)
--- a/interface/font.h
+++ b/interface/font.h
@@ -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

diff --git a/interface/gdicmn.h b/interface/gdicmn.h
index cd3f33a15eeb06f490bc328c41641863c688aa33..4c6326d2b09dd8ce1ab06ccfcb922f9959414d74 100644 (file)
--- a/interface/gdicmn.h
+++ b/interface/gdicmn.h
@@ -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 */
 //@{
 
 /**

diff --git a/interface/icon.h b/interface/icon.h
index c66d073aeda346e8e8331c18793a08faedc21d56..714fe5d5b49ea0721541ee745db04a30195399aa 100644 (file)
--- a/interface/icon.h
+++ b/interface/icon.h
@@ -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

diff --git a/interface/image.h b/interface/image.h
index c3ae734275fb5a5b711718f726f13eb4f301dbe5..c3caaebe66bcaed9d70aee6a318a78f3ecce5342 100644 (file)
--- a/interface/image.h
+++ b/interface/image.h
@@ -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

diff --git a/interface/imaglist.h b/interface/imaglist.h
index f66d1dbdc59bf9ab477eab0acc3fa48cd00d35c5..8a80b1b7d797580e34ac8984d29f16e4c191399a 100644 (file)
--- a/interface/imaglist.h
+++ b/interface/imaglist.h
@@ -8,6 +8,7 @@
 
 /**
     @class wxImageList
+    @ingroup group_class_gdi
     @wxheader{imaglist.h}
 
     A wxImageList contains a list of images, which are stored in

diff --git a/interface/metafile.h b/interface/metafile.h
index 9fd2a88c1ec3c85d11dd7f595d257bb0eb41f088..30450985c0a93401d172cdd640b76bec651572b9 100644 (file)
--- a/interface/metafile.h
+++ b/interface/metafile.h
@@ -117,7 +117,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @addtogroup group_gdi */
+/** @ingroup group_funcmacro_gdi */
 //@{
 
 /**

diff --git a/interface/palette.h b/interface/palette.h
index 2630124016eee7f6ea8bdfa1f5b39b09860fc31a..fff7fc037a9ecccf195ae10f79cc5191688b467b 100644 (file)
--- a/interface/palette.h
+++ b/interface/palette.h
@@ -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

diff --git a/interface/pen.h b/interface/pen.h
index 9a9a2833ac41c1d4993b8fb4d286faeb37bf05b6..5684c4d4049bc02b00ba180fa6c98f8c11a8d93c 100644 (file)
--- a/interface/pen.h
+++ b/interface/pen.h
@@ -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

diff --git a/interface/region.h b/interface/region.h
index 89059cb114d4de31ccd9836f93af586c4a7fb93b..72400cab98eabf06c328331bb6032d17780802d7 100644 (file)
--- a/interface/region.h
+++ b/interface/region.h
@@ -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.

diff --git a/interface/renderer.h b/interface/renderer.h
index d57cc69a8a5d7e4b5e33b501f69dd3a646f29e7d..cfd5ca225dd5a88135cbb29af3161d1096c1e7d9 100644 (file)
--- a/interface/renderer.h
+++ b/interface/renderer.h
@@ -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.