]> git.saurik.com Git - wxWidgets.git/commitdiff
link class groups with macro groups and provide a brief description for all groups
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 12 Dec 2008 18:51:54 +0000 (18:51 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Fri, 12 Dec 2008 18:51:54 +0000 (18:51 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57292 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

30 files changed:
docs/doxygen/groups/class_appmanagement.h
docs/doxygen/groups/class_archive.h
docs/doxygen/groups/class_debugging.h
docs/doxygen/groups/class_events.h
docs/doxygen/groups/class_file.h
docs/doxygen/groups/class_gdi.h
docs/doxygen/groups/class_gl.h
docs/doxygen/groups/class_grid.h
docs/doxygen/groups/class_help.h
docs/doxygen/groups/class_logging.h
docs/doxygen/groups/class_managedwnd.h
docs/doxygen/groups/class_media.h
docs/doxygen/groups/class_menus.h
docs/doxygen/groups/class_misc.h
docs/doxygen/groups/class_net.h
docs/doxygen/groups/class_rtti.h
docs/doxygen/groups/class_threading.h
docs/doxygen/groups/class_xml.h
docs/doxygen/groups/funcmacro_appinitterm.h
docs/doxygen/groups/funcmacro_debug.h
docs/doxygen/groups/funcmacro_events.h
docs/doxygen/groups/funcmacro_file.h
docs/doxygen/groups/funcmacro_gdi.h
docs/doxygen/groups/funcmacro_log.h
docs/doxygen/groups/funcmacro_math.h
docs/doxygen/groups/funcmacro_misc.h
docs/doxygen/groups/funcmacro_networkuseros.h
docs/doxygen/groups/funcmacro_rtti.h
docs/doxygen/groups/funcmacro_string.h
docs/doxygen/groups/funcmacro_thread.h

index d58e0e4e1c1181fff83e35e8f910f66c1d291181..95f805f2377afa4a63e1e176d31559c83cee0fa5 100644 (file)
 @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.
+
 */
 
index b9777ddb26f78412a244bf61583b39562c6ac90d..a4ce5308d96e99a6be273a745d6c309df5629350 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_archive Archive support
 @ingroup group_class
 
+Classes for managing (eventually compressed) archives.
+
 */
 
index bd49c00d3f03e74d48ce2953bbe80c8c26b19814..89e189fdf5302a7521bb55262308ad07be91f4ea 100644 (file)
@@ -16,5 +16,7 @@ functions and macros.
 
 Related Overviews: @ref overview_debugging
 
+Related macros/global-functions group: @ref group_funcmacro_debug
+
 */
 
index a4d945af8c522a344d7855bcf991076201a89b1a..89cb965d5857eec8d342f48a4a531e702997ca84 100644 (file)
@@ -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
+
 */
 
index 2dd65a77a61ad70e33956f496e5a2e6588d38346..44b413240f97e0eb0717dc9fc2d337051c439899 100644 (file)
@@ -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
+
 */
 
index 870e2124a377247bdd7d0b69728a17f98f19dc13..8b772da1345bbd7c6b8ae7d734b663c8c15a33bb 100644 (file)
@@ -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
+
+
 */
 
index 959fe24a21619eaa827773bd6c568752c492f757..5a7e7add89c15b79a4ee6749cd16f0f2573ae0d8 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_gl OpenGL
 @ingroup group_class
 
+Classes interfacing wxWidgets with OpenGL (http://opengl.org/).
+
 */
 
index 3fbace7928815a90ce915cadc14c8c9cf64f2d7d..84e5d61fd80daacae6ba0453694640cebc413f62 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_grid Grid Related Classes
 @ingroup group_class
 
+Classes related to the wxGrid generic widget.
+
 */
 
index 18162c2082c21c1202b104db49e1674ae8d4d559..d779e87ecb17d678f2c9d21fa5c4e5df75fdfa55 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_help Help
 @ingroup group_class
 
+Classes for loading and displaying help manuals or help informations in general.
+
 */
 
index 546f170bd1e5d9a983d0eec948b3a928e84a7d0c..c8f87d316f3696f5e96fbd9b3f6fc64534245f49 100644 (file)
@@ -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
+
 */
 
index bee93aaf1956040c946b862a763bf6c28e7c65a6..e4e3ae02767e4a32e84e1d1f21a1015a74aa69d8 100644 (file)
@@ -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
+
 */
 
index 0ac8df9bf86838ffa9b9005000f33c6d707baab2..8b074f2ee979abc8343bbd1c489a87e4fe49251f 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_media Multimedia
 @ingroup group_class
 
+Classes for showing multimedia contents.
+
 */
 
index 9448ace4d5272c366edac07b1b133c9a3ead6dbd..ebd3171fe4ed980d8c1e4bfa69a03ae5798f65e6 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_class_menus Menus
 @ingroup group_class
 
+Group of classes for handling menu bars and items.
+
 */
 
index 58cca1416ca7b11adbeafe20bb8fe3ee83472995..0378d67f0e06c8364110610ac0b8692a5547be85 100644 (file)
@@ -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
+
 */
 
index 5aa31e28f860a598d3ec971a57160182cac5bf66..4daa7d41e772e20d76af49ce7ab5eb7518ccd147 100644 (file)
@@ -13,5 +13,7 @@
 
 wxWidgets provides its own classes for socket based networking.
 
+Related macros/global-functions group: @ref group_funcmacro_networkuseros
+
 */
 
index 92980bc247cfee84dbfd5c3e02591c7bbfca72ad..f2f1b7eff779378446017d1bd0a031db85eee0a7 100644 (file)
@@ -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
 
 */
 
index e62451ac6b7ba87a1496268e6076c6f6c6b7b3df..718a75bb6a97c2e8f36fb097526feffa196ee535 100644 (file)
@@ -16,5 +16,7 @@ capabilities of the various platforms.
 
 Related Overviews: @ref overview_thread
 
+Related macros/global-functions group: @ref group_funcmacro_thread
+
 */
 
index 1e80dd581df668e5c6230faf009b6b4b32211818..49d527118557b9bacd41171ea017d0006367bd13 100644 (file)
@@ -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/).
+
 */
 
index aeaaa2a7f6805a4620b6ef590d5d685e507127d8..f60ef5ec995a0f8f80ece2bb10c9176e7c23abbb 100644 (file)
@@ -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.
+
 */
 
index 5024ec607fada9a0183f263834ec786905af705e..bf313f6c3324786bdd9995c32de0b026c040f63e 100644 (file)
@@ -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.
+
 */
 
index e12be48f99581cd69889eeb3bd5486528f5b3e91..5f7bec3db1b425fa19df7c9c5f010436971817aa 100644 (file)
@@ -13,5 +13,7 @@
 
 Below are a number of functions/macros used with wxWidgets event-handling system.
 
+Related class group: @ref group_class_events
+
 */
 
index 3a8f8a92a2fd5dfbbf646f1d7d8539d6483ee291..ea7249830329a5331616ea375f958d10ee7a9015 100644 (file)
@@ -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
 
 */
 
index 8f98c93e366a8c2cfc1777b9da236ba74b239d07..1fa7c8ee9fa974253c033afa1430143f3f0458ca 100644 (file)
@@ -16,5 +16,7 @@ Interface) access.
 
 Related Overviews: @ref overview_dc
 
+Related class group: @ref group_class_gdi
+
 */
 
index 357049742d62fba904aa2e446340124cfc601be9..3f14899ed70e8f94c270a6e27b465a5207c0f9b9 100644 (file)
@@ -18,5 +18,7 @@ the beginning of the program).
 
 Related Overviews: @ref overview_log
 
+Related class group: @ref group_class_logging
+
 */
 
index ee726b83c6bf25d1ff600ba29822e21d6acc2598..bb694827d9e1fbcf293d378f0903fd8d2b07f5cb 100644 (file)
@@ -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.
+
+
 */
 
index 0f56c3bf8625fa959209783ddcceb52a7820924c..824e2d51abfe99b09524a02799a54cf074cb22ec 100644 (file)
@@ -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
+
 */
 
index 6606ec79e7c9b78306b5d1f9ece67659b4544cdb..281de56b6ed69468bb07cbd3fb88ed3feea80d5e 100644 (file)
@@ -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.
+
 */
 
index efc6cf53ab94292608fd711775e7d02f75c9d536..99e6590c747b47e7571073db1a5651365717ccf3 100644 (file)
@@ -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
+
 */
 
index 45e649d38cbf864631b1af6020b4aceed63a288f..d51c2beb567d4a60b0a71329bbe928df00216046 100644 (file)
@@ -11,5 +11,7 @@
 @defgroup group_funcmacro_string Strings
 @ingroup group_funcmacro
 
+Global string functions and macros. See wxString for the wxWidgets string class.
+
 */
 
index 4fdc5dd02af4956c3e14a459c10344c1ea4b5a4b..0a2b23bdcfef08082aa0f690468e14f832e362ce 100644 (file)
@@ -23,5 +23,7 @@ section only when needed.
 
 @sa wxThread, wxMutex, @ref overview_thread
 
+Related class group: @ref group_class_threading
+
 */