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
2008-12-12 18:51:54 +00:00
parent cd4f6f5f8f
commit dbbca9fdea
30 changed files with 68 additions and 2 deletions
--- 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.
+
 */

--- 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.
+
 */

--- 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
+
 */

--- 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
+
 */

--- 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
+
 */

--- 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
+
+
 */

--- 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/).
+
 */

--- 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.
+
 */

--- 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.
+
 */

--- 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
+
 */

--- 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
+
 */

--- 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.
+
 */

--- 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.
+
 */

--- 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
+
 */

--- 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
+
 */

--- 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

 */

--- 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
+
 */

--- 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/).
+
 */

--- 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.
+
 */

--- 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.
+
 */

--- 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
+
 */

--- 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

 */

--- 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
+
 */

--- 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
+
 */

--- 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.
+
+
 */

--- 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
+
 */

--- 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.
+
 */

--- 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
+
 */

--- 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.
+
 */

--- 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
+
 */