From: Bryan Petty Date: Fri, 14 Mar 2008 05:47:17 +0000 (+0000) Subject: Added the function and macro group pages for Doxygen. X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/dae2800ac82493e2f3cae2ce0231309a8e877683 Added the function and macro group pages for Doxygen. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52477 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/groups/funcmacro_appinitterm.h b/docs/doxygen/groups/funcmacro_appinitterm.h new file mode 100644 index 0000000000..aeaaa2a7f6 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_appinitterm.h @@ -0,0 +1,18 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_appinitterm.h +// Purpose: App Initialization and Termination fn and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_appinitterm Application Initialization and Termination +@ingroup group_funcmacro + +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. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_atomic.h b/docs/doxygen/groups/funcmacro_atomic.h new file mode 100644 index 0000000000..c7059dadf5 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_atomic.h @@ -0,0 +1,30 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_atomic.h +// Purpose: Atomic Operation function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_atomic Atomic Operations +@ingroup group_funcmacro + +When using multi-threaded applications, it is often required to access or +modify memory which is shared between threads. Atomic integer and pointer +operations are an efficient way to handle this issue (another, less efficient, +way is to use a mutex or critical section). A native implementation exists for +Windows, Linux, Solaris and Mac OS X, for other OS, a wxCriticalSection is used +to protect the data. + +One particular application is reference counting (used by so-called smart +pointers). + +You should define your variable with the type wxAtomicInt in order to apply +atomic operations to it. + +@header{wx/atomic.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_byteorder.h b/docs/doxygen/groups/funcmacro_byteorder.h new file mode 100644 index 0000000000..5a6c3e15a1 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_byteorder.h @@ -0,0 +1,22 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_byteorder.h +// Purpose: Byte Order function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_byteorder Byte Order +@ingroup group_funcmacro + +The endian-ness issues (that is the difference between big-endian and +little-endian architectures) are important for the portable programs working +with the external binary data (for example, data files or data coming from +network) which is usually in some fixed, platform-independent format. + +The macros are helpful for transforming the data to the correct format. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_clipboard.h b/docs/doxygen/groups/funcmacro_clipboard.h new file mode 100644 index 0000000000..3f123853bf --- /dev/null +++ b/docs/doxygen/groups/funcmacro_clipboard.h @@ -0,0 +1,21 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_clipboard.h +// Purpose: Clipboard function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_clipboard Clipboard +@ingroup group_funcmacro + +@warning These functions are deprecated, use the wxClipboard class instead. + +These clipboard functions are implemented for Windows only. + +@header{wx/clipbrd.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_debug.h b/docs/doxygen/groups/funcmacro_debug.h new file mode 100644 index 0000000000..74bc4819f5 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_debug.h @@ -0,0 +1,26 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_debug.h +// Purpose: Debugging function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_debug Debugging +@ingroup group_funcmacro + +Useful macros and functions for error checking and defensive programming. +wxWidgets defines three families of the assert-like macros: the wxASSERT and +wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in +the debug build) but disappear completely in the release build. On the other +hand, the wxCHECK macros stay event in release builds but a check failure +doesn't generate any user-visible effects then. 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. + +@header{wx/debug.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_dialog.h b/docs/doxygen/groups/funcmacro_dialog.h new file mode 100644 index 0000000000..ede30f0ea2 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_dialog.h @@ -0,0 +1,21 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_dialog.h +// Purpose: Dialog function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_dialog Dialogs +@ingroup group_funcmacro + +Below are a number of convenience functions for getting input from the user +or displaying messages. Note that in these functions the last three parameters +are optional. However, it is recommended to pass a parent frame parameter, or +(in MS Windows or Motif) the wrong window frame may be brought to the front when +the dialog box is popped up. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_env.h b/docs/doxygen/groups/funcmacro_env.h new file mode 100644 index 0000000000..cde7f2e079 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_env.h @@ -0,0 +1,21 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_env.h +// Purpose: Environment function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_env Environment +@ingroup group_funcmacro + +The functions in this section allow to access (get) or change value of +environment variables in a portable way. They are currently implemented under +Win32 and POSIX-like systems (Unix). + +@header{wx/utils.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_file.h b/docs/doxygen/groups/funcmacro_file.h new file mode 100644 index 0000000000..6e5dcf5ab8 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_file.h @@ -0,0 +1,19 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_file.h +// Purpose: Files and Directories function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_file Files and Directories +@ingroup group_funcmacro + +@header{wx/filefn.h} + +@sa wxPathList, wxDir, wxFile, wxFileName + +*/ + diff --git a/docs/doxygen/groups/funcmacro_log.h b/docs/doxygen/groups/funcmacro_log.h new file mode 100644 index 0000000000..bb2aee3e9b --- /dev/null +++ b/docs/doxygen/groups/funcmacro_log.h @@ -0,0 +1,24 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_log.h +// Purpose: Logging function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_log Logging +@ingroup group_funcmacro + +These functions provide a variety of logging functions. The functions use +(implicitly) the currently active log target, so their descriptions here may +not apply if the log target is not the standard one (installed by wxWidgets in +the beginning of the program). + +Related Overviews: @ref overview_log + +@header{wx/log.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_math.h b/docs/doxygen/groups/funcmacro_math.h new file mode 100644 index 0000000000..30093d6314 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_math.h @@ -0,0 +1,17 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_math.h +// Purpose: Math function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_math Math +@ingroup group_funcmacro + +@header{wx/math.h} + +*/ + diff --git a/docs/doxygen/groups/funcmacro_misc.h b/docs/doxygen/groups/funcmacro_misc.h new file mode 100644 index 0000000000..0f56c3bf86 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_misc.h @@ -0,0 +1,15 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_misc.h +// Purpose: Miscellaneous function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_misc Miscellaneous +@ingroup group_funcmacro + +*/ + diff --git a/docs/doxygen/groups/funcmacro_networkuseros.h b/docs/doxygen/groups/funcmacro_networkuseros.h new file mode 100644 index 0000000000..6606ec79e7 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_networkuseros.h @@ -0,0 +1,18 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_networkuseros.h +// Purpose: Network, User and OS function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_networkuseros.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_networkuseros Network, User and OS +@ingroup group_funcmacro + +The functions in this section are used to retrieve information about the +current computer and/or user characteristics. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_procctrl.h b/docs/doxygen/groups/funcmacro_procctrl.h new file mode 100644 index 0000000000..52ce34376f --- /dev/null +++ b/docs/doxygen/groups/funcmacro_procctrl.h @@ -0,0 +1,18 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_procctrl.h +// Purpose: Process Control function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_procctrl Process Control +@ingroup group_funcmacro + +The functions in this section are used to launch or terminate the other +processes. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_rtti.h b/docs/doxygen/groups/funcmacro_rtti.h new file mode 100644 index 0000000000..efc6cf53ab --- /dev/null +++ b/docs/doxygen/groups/funcmacro_rtti.h @@ -0,0 +1,25 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_rtti.h +// Purpose: Runtime Type Information function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_rtti Runtime Type Information (RTTI) +@ingroup group_funcmacro + +wxWidgets uses its own RTTI ("run-time type identification") system which +predates the current standard C++ RTTI and so is kept for backwards +compatibility reasons but also because it allows some things which the standard +RTTI doesn't directly support (such as creating a class from its name). The +standard C++ RTTI can be used in the user code without any problems and in +general you shouldn't need to use the functions and the macros in this section +unless you are thinking of modifying or adding any wxWidgets classes. + +Related Overviews: @ref overview_rtti + +*/ + diff --git a/docs/doxygen/groups/funcmacro_string.h b/docs/doxygen/groups/funcmacro_string.h new file mode 100644 index 0000000000..45e649d38c --- /dev/null +++ b/docs/doxygen/groups/funcmacro_string.h @@ -0,0 +1,15 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_string.h +// Purpose: String function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_string Strings +@ingroup group_funcmacro + +*/ + diff --git a/docs/doxygen/groups/funcmacro_thread.h b/docs/doxygen/groups/funcmacro_thread.h new file mode 100644 index 0000000000..1bcd6a9002 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_thread.h @@ -0,0 +1,29 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_thread.h +// Purpose: Threads function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_thread Threads +@ingroup group_funcmacro + +The functions and macros here mainly exist to make it writing the code which +may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in single +thread configuration (wxUSE_THREADS = 0). + +For example, a static variable must be protected against simultaneous access by +multiple threads in the former configuration but in the latter the extra +overhead of using the critical section is not needed. To solve this problem, +the wxCRITICAL_SECTION macro may be used to create and use the critical section +only when needed. + +@header{wx/thread.h} + +@sa wxThread, wxMutex, @ref overview_thread + +*/ + diff --git a/docs/doxygen/groups/funcmacro_time.h b/docs/doxygen/groups/funcmacro_time.h new file mode 100644 index 0000000000..d1046ff1c9 --- /dev/null +++ b/docs/doxygen/groups/funcmacro_time.h @@ -0,0 +1,18 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_time.h +// Purpose: Time function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_time Time +@ingroup group_funcmacro + +The functions in this section deal with getting the current time and sleeping +for the specified time interval. + +*/ + diff --git a/docs/doxygen/groups/funcmacro_version.h b/docs/doxygen/groups/funcmacro_version.h new file mode 100644 index 0000000000..b65fac553f --- /dev/null +++ b/docs/doxygen/groups/funcmacro_version.h @@ -0,0 +1,38 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_version.h +// Purpose: Versioning function and macro group docs +// Author: wxWidgets team +// RCS-ID: $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_version Versioning +@ingroup group_funcmacro + +The following constants are defined in wxWidgets: + +@beginDefList +@itemdef{ wxMAJOR_VERSION, The major version of wxWidgets } +@itemdef{ wxMINOR_VERSION, The minor version of wxWidgets } +@itemdef{ wxRELEASE_NUMBER, The release number } +@itemdef{ wxSUBRELEASE_NUMBER, The subrelease number which is 0 for all + official releases } +@endDefList + +For example, the values or these constants for wxWidgets 2.8.7 +are 2, 8, 7 and 0. + +Additionally, wxVERSION_STRING is a user-readable string containing the full +wxWidgets version and wxVERSION_NUMBER is a combination of the three version +numbers above: for 2.1.15, it is 2115 and it is 2200 for wxWidgets 2.2. + +The subrelease number is only used for the sources in between official releases +and so normally is not useful. + +@header{wx/version.h} +@header{wx/defs.h} + +*/ +