From dbbca9fdea4add28c63d0e9ca32c84429400f98d Mon Sep 17 00:00:00 2001
From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Fri, 12 Dec 2008 18:51:54 +0000
Subject: [PATCH] link class groups with macro groups and provide a brief
 description for all groups

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57292 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/doxygen/groups/class_appmanagement.h     | 5 +++++
 docs/doxygen/groups/class_archive.h           | 2 ++
 docs/doxygen/groups/class_debugging.h         | 2 ++
 docs/doxygen/groups/class_events.h            | 2 ++
 docs/doxygen/groups/class_file.h              | 2 ++
 docs/doxygen/groups/class_gdi.h               | 3 +++
 docs/doxygen/groups/class_gl.h                | 2 ++
 docs/doxygen/groups/class_grid.h              | 2 ++
 docs/doxygen/groups/class_help.h              | 2 ++
 docs/doxygen/groups/class_logging.h           | 2 ++
 docs/doxygen/groups/class_managedwnd.h        | 2 ++
 docs/doxygen/groups/class_media.h             | 2 ++
 docs/doxygen/groups/class_menus.h             | 2 ++
 docs/doxygen/groups/class_misc.h              | 4 ++++
 docs/doxygen/groups/class_net.h               | 2 ++
 docs/doxygen/groups/class_rtti.h              | 2 +-
 docs/doxygen/groups/class_threading.h         | 2 ++
 docs/doxygen/groups/class_xml.h               | 2 ++
 docs/doxygen/groups/funcmacro_appinitterm.h   | 2 ++
 docs/doxygen/groups/funcmacro_debug.h         | 2 ++
 docs/doxygen/groups/funcmacro_events.h        | 2 ++
 docs/doxygen/groups/funcmacro_file.h          | 2 +-
 docs/doxygen/groups/funcmacro_gdi.h           | 2 ++
 docs/doxygen/groups/funcmacro_log.h           | 2 ++
 docs/doxygen/groups/funcmacro_math.h          | 4 ++++
 docs/doxygen/groups/funcmacro_misc.h          | 4 ++++
 docs/doxygen/groups/funcmacro_networkuseros.h | 2 ++
 docs/doxygen/groups/funcmacro_rtti.h          | 2 ++
 docs/doxygen/groups/funcmacro_string.h        | 2 ++
 docs/doxygen/groups/funcmacro_thread.h        | 2 ++
 30 files changed, 68 insertions(+), 2 deletions(-)

diff --git a/docs/doxygen/groups/class_appmanagement.h b/docs/doxygen/groups/class_appmanagement.h
index d58e0e4e1c..95f805f237 100644
--- a/docs/doxygen/groups/class_appmanagement.h
+++ b/docs/doxygen/groups/class_appmanagement.h
@@ -11,5 +11,10 @@
 @defgroup group_class_appmanagement Application and Process Management
 @ingroup group_class
 
+The classes in this section are used to handle application-wide settings or
+for initialization/shutdown of the application itself.
+
+Related macros/global-functions group: @ref group_funcmacro_appinitterm.
+
 */
 
diff --git a/docs/doxygen/groups/class_archive.h b/docs/doxygen/groups/class_archive.h
index b9777ddb26..a4ce5308d9 100644
--- a/docs/doxygen/groups/class_archive.h
+++ b/docs/doxygen/groups/class_archive.h
@@ -11,5 +11,7 @@
 @defgroup group_class_archive Archive support
 @ingroup group_class
 
+Classes for managing (eventually compressed) archives.
+
 */
 
diff --git a/docs/doxygen/groups/class_debugging.h b/docs/doxygen/groups/class_debugging.h
index bd49c00d3f..89e189fdf5 100644
--- a/docs/doxygen/groups/class_debugging.h
+++ b/docs/doxygen/groups/class_debugging.h
@@ -16,5 +16,7 @@ functions and macros.
 
 Related Overviews: @ref overview_debugging
 
+Related macros/global-functions group: @ref group_funcmacro_debug
+
 */
 
diff --git a/docs/doxygen/groups/class_events.h b/docs/doxygen/groups/class_events.h
index a4d945af8c..89cb965d58 100644
--- a/docs/doxygen/groups/class_events.h
+++ b/docs/doxygen/groups/class_events.h
@@ -16,5 +16,7 @@ An event object contains information about a specific event. Event handlers
 
 Related Overviews: @ref overview_eventhandling
 
+Related macros/global-functions group: @ref group_funcmacro_events
+
 */
 
diff --git a/docs/doxygen/groups/class_file.h b/docs/doxygen/groups/class_file.h
index 2dd65a77a6..44b413240f 100644
--- a/docs/doxygen/groups/class_file.h
+++ b/docs/doxygen/groups/class_file.h
@@ -15,5 +15,7 @@ wxWidgets has several small classes to work with disk files and directories.
 
 Related Overviews: @ref overview_file
 
+Related macros/global-functions group: @ref group_funcmacro_file
+
 */
 
diff --git a/docs/doxygen/groups/class_gdi.h b/docs/doxygen/groups/class_gdi.h
index 870e2124a3..8b772da134 100644
--- a/docs/doxygen/groups/class_gdi.h
+++ b/docs/doxygen/groups/class_gdi.h
@@ -16,5 +16,8 @@ They provide an API for drawing on device contexts, windows, and printing.
 
 Related Overviews: @ref overview_dc, @ref overview_bitmap
 
+Related macros/global-functions group: @ref group_funcmacro_gdi
+
+
 */
 
diff --git a/docs/doxygen/groups/class_gl.h b/docs/doxygen/groups/class_gl.h
index 959fe24a21..5a7e7add89 100644
--- a/docs/doxygen/groups/class_gl.h
+++ b/docs/doxygen/groups/class_gl.h
@@ -11,5 +11,7 @@
 @defgroup group_class_gl OpenGL
 @ingroup group_class
 
+Classes interfacing wxWidgets with OpenGL (http://opengl.org/).
+
 */
 
diff --git a/docs/doxygen/groups/class_grid.h b/docs/doxygen/groups/class_grid.h
index 3fbace7928..84e5d61fd8 100644
--- a/docs/doxygen/groups/class_grid.h
+++ b/docs/doxygen/groups/class_grid.h
@@ -11,5 +11,7 @@
 @defgroup group_class_grid Grid Related Classes
 @ingroup group_class
 
+Classes related to the wxGrid generic widget.
+
 */
 
diff --git a/docs/doxygen/groups/class_help.h b/docs/doxygen/groups/class_help.h
index 18162c2082..d779e87ecb 100644
--- a/docs/doxygen/groups/class_help.h
+++ b/docs/doxygen/groups/class_help.h
@@ -11,5 +11,7 @@
 @defgroup group_class_help Help
 @ingroup group_class
 
+Classes for loading and displaying help manuals or help informations in general.
+
 */
 
diff --git a/docs/doxygen/groups/class_logging.h b/docs/doxygen/groups/class_logging.h
index 546f170bd1..c8f87d316f 100644
--- a/docs/doxygen/groups/class_logging.h
+++ b/docs/doxygen/groups/class_logging.h
@@ -15,5 +15,7 @@ wxWidgets provides several classes and functions for message logging.
 
 Related Overviews: @ref overview_log
 
+Related macros/global-functions group: @ref group_funcmacro_log
+
 */
 
diff --git a/docs/doxygen/groups/class_managedwnd.h b/docs/doxygen/groups/class_managedwnd.h
index bee93aaf19..e4e3ae0276 100644
--- a/docs/doxygen/groups/class_managedwnd.h
+++ b/docs/doxygen/groups/class_managedwnd.h
@@ -17,5 +17,7 @@ are similar in wxWidgets, but only dialogs may be modal.
 
 Related Overviews: @ref overview_cmndlg
 
+Related macros/global-functions group: @ref group_funcmacro_dialog
+
 */
 
diff --git a/docs/doxygen/groups/class_media.h b/docs/doxygen/groups/class_media.h
index 0ac8df9bf8..8b074f2ee9 100644
--- a/docs/doxygen/groups/class_media.h
+++ b/docs/doxygen/groups/class_media.h
@@ -11,5 +11,7 @@
 @defgroup group_class_media Multimedia
 @ingroup group_class
 
+Classes for showing multimedia contents.
+
 */
 
diff --git a/docs/doxygen/groups/class_menus.h b/docs/doxygen/groups/class_menus.h
index 9448ace4d5..ebd3171fe4 100644
--- a/docs/doxygen/groups/class_menus.h
+++ b/docs/doxygen/groups/class_menus.h
@@ -11,5 +11,7 @@
 @defgroup group_class_menus Menus
 @ingroup group_class
 
+Group of classes for handling menu bars and items.
+
 */
 
diff --git a/docs/doxygen/groups/class_misc.h b/docs/doxygen/groups/class_misc.h
index 58cca1416c..0378d67f0e 100644
--- a/docs/doxygen/groups/class_misc.h
+++ b/docs/doxygen/groups/class_misc.h
@@ -11,5 +11,9 @@
 @defgroup group_class_misc Miscellaneous
 @ingroup group_class
 
+Group of miscellaneous classes.
+
+Related macros/global-functions group: @ref group_funcmacro_misc
+
 */
 
diff --git a/docs/doxygen/groups/class_net.h b/docs/doxygen/groups/class_net.h
index 5aa31e28f8..4daa7d41e7 100644
--- a/docs/doxygen/groups/class_net.h
+++ b/docs/doxygen/groups/class_net.h
@@ -13,5 +13,7 @@
 
 wxWidgets provides its own classes for socket based networking.
 
+Related macros/global-functions group: @ref group_funcmacro_networkuseros
+
 */
 
diff --git a/docs/doxygen/groups/class_rtti.h b/docs/doxygen/groups/class_rtti.h
index 92980bc247..f2f1b7eff7 100644
--- a/docs/doxygen/groups/class_rtti.h
+++ b/docs/doxygen/groups/class_rtti.h
@@ -16,7 +16,7 @@ creation of objects given class names.
 
 Related Overviews: @ref overview_rtti
 
-See also: @ref group_funcmacro_rtti "RTTI Functions and Macros"
+Related macros/global-functions group: @ref group_funcmacro_rtti
 
 */
 
diff --git a/docs/doxygen/groups/class_threading.h b/docs/doxygen/groups/class_threading.h
index e62451ac6b..718a75bb6a 100644
--- a/docs/doxygen/groups/class_threading.h
+++ b/docs/doxygen/groups/class_threading.h
@@ -16,5 +16,7 @@ capabilities of the various platforms.
 
 Related Overviews: @ref overview_thread
 
+Related macros/global-functions group: @ref group_funcmacro_thread
+
 */
 
diff --git a/docs/doxygen/groups/class_xml.h b/docs/doxygen/groups/class_xml.h
index 1e80dd581d..49d5271185 100644
--- a/docs/doxygen/groups/class_xml.h
+++ b/docs/doxygen/groups/class_xml.h
@@ -11,5 +11,7 @@
 @defgroup group_class_xml XML
 @ingroup group_class
 
+Group of classes loading and saving XML documents (http://www.w3.org/XML/).
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_appinitterm.h b/docs/doxygen/groups/funcmacro_appinitterm.h
index aeaaa2a7f6..f60ef5ec99 100644
--- a/docs/doxygen/groups/funcmacro_appinitterm.h
+++ b/docs/doxygen/groups/funcmacro_appinitterm.h
@@ -14,5 +14,7 @@
 The functions in this section are used on application startup/shutdown and also
 to control the behaviour of the main event loop of the GUI programs.
 
+Related macros/global-functions group: @ref group_class_appmanagement.
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_debug.h b/docs/doxygen/groups/funcmacro_debug.h
index 5024ec607f..bf313f6c33 100644
--- a/docs/doxygen/groups/funcmacro_debug.h
+++ b/docs/doxygen/groups/funcmacro_debug.h
@@ -20,5 +20,7 @@ generate any user-visible effects. Finally, the compile time assertions don't
 happen during the run-time but result in the compilation error messages if the
 condition they check fail.
 
+Related class group: @ref group_class_debugging.
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_events.h b/docs/doxygen/groups/funcmacro_events.h
index e12be48f99..5f7bec3db1 100644
--- a/docs/doxygen/groups/funcmacro_events.h
+++ b/docs/doxygen/groups/funcmacro_events.h
@@ -13,5 +13,7 @@
 
 Below are a number of functions/macros used with wxWidgets event-handling system.
 
+Related class group: @ref group_class_events
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_file.h b/docs/doxygen/groups/funcmacro_file.h
index 3a8f8a92a2..ea72498303 100644
--- a/docs/doxygen/groups/funcmacro_file.h
+++ b/docs/doxygen/groups/funcmacro_file.h
@@ -14,7 +14,7 @@
 These functions provide a platform-independent API for common file and
 directory functionality.
 
-@see wxPathList, wxDir, wxFile, wxFileName
+Related class group: @ref group_class_file
 
 */
 
diff --git a/docs/doxygen/groups/funcmacro_gdi.h b/docs/doxygen/groups/funcmacro_gdi.h
index 8f98c93e36..1fa7c8ee9f 100644
--- a/docs/doxygen/groups/funcmacro_gdi.h
+++ b/docs/doxygen/groups/funcmacro_gdi.h
@@ -16,5 +16,7 @@ Interface) access.
 
 Related Overviews: @ref overview_dc
 
+Related class group: @ref group_class_gdi
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_log.h b/docs/doxygen/groups/funcmacro_log.h
index 357049742d..3f14899ed7 100644
--- a/docs/doxygen/groups/funcmacro_log.h
+++ b/docs/doxygen/groups/funcmacro_log.h
@@ -18,5 +18,7 @@ the beginning of the program).
 
 Related Overviews: @ref overview_log
 
+Related class group: @ref group_class_logging
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_math.h b/docs/doxygen/groups/funcmacro_math.h
index ee726b83c6..bb694827d9 100644
--- a/docs/doxygen/groups/funcmacro_math.h
+++ b/docs/doxygen/groups/funcmacro_math.h
@@ -11,5 +11,9 @@
 @defgroup group_funcmacro_math Math
 @ingroup group_funcmacro
 
+The functions in this section are typically related with math operations and
+floating point numbers.
+
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_misc.h b/docs/doxygen/groups/funcmacro_misc.h
index 0f56c3bf86..824e2d51ab 100644
--- a/docs/doxygen/groups/funcmacro_misc.h
+++ b/docs/doxygen/groups/funcmacro_misc.h
@@ -11,5 +11,9 @@
 @defgroup group_funcmacro_misc Miscellaneous
 @ingroup group_funcmacro
 
+Group of miscellaneous functions and macros.
+
+Related class group: @ref group_class_misc
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_networkuseros.h b/docs/doxygen/groups/funcmacro_networkuseros.h
index 6606ec79e7..281de56b6e 100644
--- a/docs/doxygen/groups/funcmacro_networkuseros.h
+++ b/docs/doxygen/groups/funcmacro_networkuseros.h
@@ -14,5 +14,7 @@
 The functions in this section are used to retrieve information about the
 current computer and/or user characteristics.
 
+Related class group: @ref group_class_net.
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_rtti.h b/docs/doxygen/groups/funcmacro_rtti.h
index efc6cf53ab..99e6590c74 100644
--- a/docs/doxygen/groups/funcmacro_rtti.h
+++ b/docs/doxygen/groups/funcmacro_rtti.h
@@ -21,5 +21,7 @@ unless you are thinking of modifying or adding any wxWidgets classes.
 
 Related Overviews: @ref overview_rtti
 
+Related class group: @ref group_class_rtti
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_string.h b/docs/doxygen/groups/funcmacro_string.h
index 45e649d38c..d51c2beb56 100644
--- a/docs/doxygen/groups/funcmacro_string.h
+++ b/docs/doxygen/groups/funcmacro_string.h
@@ -11,5 +11,7 @@
 @defgroup group_funcmacro_string Strings
 @ingroup group_funcmacro
 
+Global string functions and macros. See wxString for the wxWidgets string class.
+
 */
 
diff --git a/docs/doxygen/groups/funcmacro_thread.h b/docs/doxygen/groups/funcmacro_thread.h
index 4fdc5dd02a..0a2b23bdcf 100644
--- a/docs/doxygen/groups/funcmacro_thread.h
+++ b/docs/doxygen/groups/funcmacro_thread.h
@@ -23,5 +23,7 @@ section only when needed.
 
 @sa wxThread, wxMutex, @ref overview_thread
 
+Related class group: @ref group_class_threading
+
 */
 
-- 
2.45.2