Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed all doxygen warnings fixable

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52339 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-05 19:08:53 +00:00
parent c1f615bf14
commit 29d21088bb
10 changed files with 350 additions and 275 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/doxygen/Doxyfile.inc
View File

@@ -62,7 +62,7 @@ ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n"
ALIASES += endExtraStyleTable="\n" ALIASES += endExtraStyleTable="\n"
# aliases for additional wx-specific infos # aliases for additional wx-specific infos
ALIASES += library{1}="\section class_lib Library\n Belongs to library \ref page_libs_\1" ALIASES += library{1}="\section class_lib Library\n Belongs to library \ref page_libs_\1."
ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based." ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based."
ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b" ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b"
ALIASES += category{1}="\section class_category Category\n \1" ALIASES += category{1}="\section class_category Category\n \1"
@@ -86,7 +86,10 @@ ALIASES += seealso="\section class_sa See also\n"
# IMPORTANT: the \headerfile command does not work everywhere we'd need it, # IMPORTANT: the \headerfile command does not work everywhere we'd need it,
# e.g. in the constants page we need to specify an header file # e.g. in the constants page we need to specify an header file
# even if they're not inside a \class, \function or \struct command.... # even if they're not inside a \class, \function or \struct command....
# and also inside a \class, we want to specify the header file only once
# and not twice as the \headerfile command requires (and thus we use @wxheader)
ALIASES += header{1}="Include file:\n \verbatim #include <\1> @endverbatim" ALIASES += header{1}="Include file:\n \verbatim #include <\1> @endverbatim"
ALIASES += wxheader{1}="\headerfile \1 wx/\1"
# some formatting aliases # some formatting aliases
# NOTE: using <b> and <tt> tags is different from using \c \b because in the last case # NOTE: using <b> and <tt> tags is different from using \c \b because in the last case
@@ -206,7 +209,7 @@ WARN_LOGFILE = doxygen.log
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = ./mainpages ./overviews ../../interface INPUT = ./mainpages ./overviews #../../interface
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.txt FILE_PATTERNS = *.h *.txt
RECURSIVE = YES RECURSIVE = YES

20
docs/doxygen/mainpages/cat_classes.h
View File

@@ -15,18 +15,18 @@
@beginInvisibleTable @beginInvisibleTable
<tr><td> <tr><td>
@li @ref page_class_cat_manwnd @li @ref page_class_cat_managedwnd
@li @ref page_class_cat_miscwnd @li @ref page_class_cat_miscwnd
@li @ref page_class_cat_cmndlg @li @ref page_class_cat_cmndlg
@li @ref page_class_cat_ctrl @li @ref page_class_cat_ctrl
@li @ref page_class_cat_miscpickers @li @ref page_class_cat_miscpickers
@li @ref page_class_cat_menus @li @ref page_class_cat_menus
@li @ref page_class_cat_wxaui @li @ref page_class_cat_aui
@li @ref page_class_cat_winlayout @li @ref page_class_cat_winlayout
@li @ref page_class_cat_dc @li @ref page_class_cat_dc
@li @ref page_class_cat_gdi @li @ref page_class_cat_gdi
@li @ref page_class_cat_events @li @ref page_class_cat_events
@li @ref page_class_cat_val @li @ref page_class_cat_validator
@li @ref page_class_cat_data @li @ref page_class_cat_data
@li @ref page_class_cat_containers @li @ref page_class_cat_containers
@li @ref page_class_cat_smartpointers @li @ref page_class_cat_smartpointers
@@ -38,12 +38,12 @@
@li @ref page_class_cat_ipc @li @ref page_class_cat_ipc
@li @ref page_class_cat_dvf @li @ref page_class_cat_dvf
@li @ref page_class_cat_printing @li @ref page_class_cat_printing
@li @ref page_class_cat_dd @li @ref page_class_cat_dnd
@li @ref page_class_cat_file @li @ref page_class_cat_file
@li @ref page_class_cat_streams @li @ref page_class_cat_streams
@li @ref page_class_cat_threading @li @ref page_class_cat_threading
@li @ref page_class_cat_html @li @ref page_class_cat_html
@li @ref page_class_cat_rich @li @ref page_class_cat_richtext
@li @ref page_class_cat_stc @li @ref page_class_cat_stc
@li @ref page_class_cat_vfs @li @ref page_class_cat_vfs
@li @ref page_class_cat_xml @li @ref page_class_cat_xml
@@ -60,7 +60,7 @@
@section page_class_cat_manwnd Managed windows @section page_class_cat_managedwnd Managed windows
There are several types of window that are directly controlled by the There are several types of window that are directly controlled by the
window manager (such as MS Windows, or the Motif Window Manager). window manager (such as MS Windows, or the Motif Window Manager).
@@ -193,7 +193,7 @@
@section page_class_cat_wxaui wxAUI - advanced user interface @section page_class_cat_aui wxAUI - advanced user interface
This is a new set of classes for writing a customizable application This is a new set of classes for writing a customizable application
interface with built-in docking, floatable panes and a flexible interface with built-in docking, floatable panes and a flexible
@@ -346,7 +346,7 @@
@li wxWizardEvent: A wizard event @li wxWizardEvent: A wizard event
@section page_class_cat_val Validators @section page_class_cat_validator Validators
@ref overview_validator @ref overview_validator
@@ -527,7 +527,7 @@
@section page_class_cat_dd Drag and drop and clipboard classes @section page_class_cat_dnd Drag and drop and clipboard classes
@ref overview_dnd @ref overview_dnd
@@ -630,7 +630,7 @@
@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
@section page_class_cat_rich Rich text classes @section page_class_cat_richtext Rich text classes
wxWidgets provides a set of generic classes to edit and print simple rich text with character wxWidgets provides a set of generic classes to edit and print simple rich text with character
and paragraph formatting. and paragraph formatting.

560
docs/doxygen/mainpages/cat_functions.h
View File

@@ -20,7 +20,7 @@
@li @ref page_func_cat_networkuseros @li @ref page_func_cat_networkuseros
@li @ref page_func_cat_string @li @ref page_func_cat_string
@li @ref page_func_cat_dialog @li @ref page_func_cat_dialog
@li @ref page_func_cat_math @li @ref page_func_cat_math
@li @ref page_func_cat_gdi @li @ref page_func_cat_gdi
@li @ref page_func_cat_printer @li @ref page_func_cat_printer
@li @ref page_func_cat_clipboard @li @ref page_func_cat_clipboard
@@ -38,290 +38,354 @@
@section page_func_cat_appinitterm Application initialization and termination @section page_func_cat_appinitterm Application initialization and termination
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. The functions in this section are used on application startup/shutdown and also
::wxEntry to control the behaviour of the main event loop of the GUI programs.
::wxEntryCleanup
::wxEntryStart @li wxEntry
::wxGetApp @li wxEntryCleanup
::wxHandleFatalExceptions @li wxEntryStart
::wxInitAllImageHandlers @li wxGetApp
::wxInitialize @li wxHandleFatalExceptions
::wxSafeYield @li wxInitAllImageHandlers
::wxUninitialize @li wxInitialize
::wxYield @li wxSafeYield
::wxWakeUpIdle @li wxUninitialize
@li wxYield
@li wxWakeUpIdle
@section page_func_cat_procctrl Process control functions @section page_func_cat_procctrl Process control functions
The functions in this section are used to launch or terminate the other processes.
::wxExecute The functions in this section are used to launch or terminate the other processes.
::wxExit
::wxJoin @li wxExecute
::wxKill @li wxExit
::wxGetProcessId @li wxJoin
::wxShell @li wxKill
::wxShutdown @li wxGetProcessId
@li wxShell
@li wxShutdown
@section page_func_cat_thread Thread functions @section page_func_cat_thread Thread functions
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.
Include files
<wx/thread.h>
See also
wxThread, wxMutex, Multithreading overview
::wxIsMainThread The functions and macros here mainly exist to make it writing the code which may be
::wxMutexGuiEnter compiled in multi thread build (wxUSE_THREADS = 1) as well as in single thread
::wxMutexGuiLeave 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
@li wxIsMainThread
@li wxMutexGuiEnter
@li wxMutexGuiLeave
@section page_func_cat_file File functions @section page_func_cat_file File functions
Include files
<wx/filefn.h>
See also
wxPathList
wxDir
wxFile
wxFileName
::wxDos2UnixFilename @header{wx/filefn.h}
::wxFileExists
::wxFileModificationTime @sa
::wxFileNameFromPath wxPathList, wxDir, wxFile, wxFileName
::wxFindFirstFile
::wxFindNextFile @li wxDos2UnixFilename
::wxGetDiskSpace @li wxFileExists
::wxGetFileKind @li wxFileModificationTime
::wxGetOSDirectory @li wxFileNameFromPath
::wxIsAbsolutePath @li wxFindFirstFile
::wxDirExists @li wxFindNextFile
::wxPathOnly @li wxGetDiskSpace
::wxUnix2DosFilename @li wxGetFileKind
::wxConcatFiles @li wxGetOSDirectory
::wxCopyFile @li wxIsAbsolutePath
::wxGetCwd @li wxDirExists
::wxGetWorkingDirectory @li wxPathOnly
::wxGetTempFileName @li wxUnix2DosFilename
::wxIsWild @li wxConcatFiles
::wxMatchWild @li wxCopyFile
::wxMkdir @li wxGetCwd
::wxParseCommonDialogsFilter @li wxGetWorkingDirectory
::wxRemoveFile @li wxGetTempFileName
::wxRenameFile @li wxIsWild
::wxRmdir @li wxMatchWild
::wxSetWorkingDirectory @li wxMkdir
::wxSplit @li wxParseCommonDialogsFilter
::wxSplitPath @li wxRemoveFile
::wxTransferFileToStream @li wxRenameFile
::wxTransferStreamToFile @li wxRmdir
@li wxSetWorkingDirectory
@li wxSplit
@li wxSplitPath
@li wxTransferFileToStream
@li wxTransferStreamToFile
@section page_func_cat_networkuseros Network, user and OS functions @section page_func_cat_networkuseros Network, user and OS functions
The functions in this section are used to retrieve information about the current computer and/or user characteristics.
::wxGetEmailAddress The functions in this section are used to retrieve information about the current
::wxGetFreeMemory computer and/or user characteristics.
::wxGetFullHostName
::wxGetHomeDir @li wxGetEmailAddress
::wxGetHostName @li wxGetFreeMemory
::wxGetOsDescription @li wxGetFullHostName
::wxGetOsVersion @li wxGetHomeDir
::wxIsPlatformLittleEndian @li wxGetHostName
::wxIsPlatform64Bit @li wxGetOsDescription
::wxGetUserHome @li wxGetOsVersion
::wxGetUserId @li wxIsPlatformLittleEndian
::wxGetUserName @li wxIsPlatform64Bit
@li wxGetUserHome
@li wxGetUserId
@li wxGetUserName
@section page_func_cat_string String functions @section page_func_cat_string String functions
::wxGetTranslation
::wxIsEmpty @li wxGetTranslation
wxS @li wxIsEmpty
::wxStrcmp @li wxStrcmp
::wxStricmp @li wxStricmp
::wxStringEq @li wxStringEq
::wxStringMatch @li wxStringMatch
::wxStringTokenize @li wxStringTokenize
::wxStrlen @li wxStrlen
::wxSnprintf @li wxSnprintf
wxT @li wxVsnprintf
wxTRANSLATE
::wxVsnprintf
_
wxPLURAL
_T
@section page_func_cat_dialog Dialog functions @section page_func_cat_dialog Dialog functions
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.
::wxAboutBox Below are a number of convenience functions for getting input from the user
::wxBeginBusyCursor or displaying messages. Note that in these functions the last three parameters
::wxBell are optional. However, it is recommended to pass a parent frame parameter, or
::wxCreateFileTipProvider (in MS Windows or Motif) the wrong window frame may be brought to the front when
::wxDirSelector the dialog box is popped up.
::wxFileSelector
::wxEndBusyCursor @li wxAboutBox
::wxGenericAboutBox @li wxBeginBusyCursor
::wxGetColourFromUser @li wxBell
::wxGetFontFromUser @li wxCreateFileTipProvider
::wxGetMultipleChoices @li wxDirSelector
::wxGetNumberFromUser @li wxFileSelector
::wxGetPasswordFromUser @li wxEndBusyCursor
::wxGetTextFromUser @li wxGenericAboutBox
::wxGetSingleChoice @li wxGetColourFromUser
::wxGetSingleChoiceIndex @li wxGetFontFromUser
::wxGetSingleChoiceData @li wxGetMultipleChoices
::wxInfoMessageBox @li wxGetNumberFromUser
::wxIsBusy @li wxGetPasswordFromUser
::wxMessageBox @li wxGetTextFromUser
::wxShowTip @li wxGetSingleChoice
@li wxGetSingleChoiceIndex
@li wxGetSingleChoiceData
@li wxInfoMessageBox
@li wxIsBusy
@li wxMessageBox
@li wxShowTip
@section page_func_cat_math Math functions @section page_func_cat_math Math functions
Include files
<wx/math.h> @header{wx/math.h}
wxFinite
wxIsNaN @li wxFinite
@li wxIsNaN
@section page_func_cat_gdi GDI functions @section page_func_cat_gdi GDI functions
The following are relevant to the GDI (Graphics Device Interface).
Include files The following are relevant to the GDI (Graphics Device Interface).
<wx/gdicmn.h>
wxBITMAP @header{gdicmn.h}
::wxClientDisplayRect
::wxColourDisplay @li wxBITMAP
::wxDisplayDepth @li wxClientDisplayRect
::wxDisplaySize @li wxColourDisplay
::wxDisplaySizeMM @li wxDisplayDepth
::wxDROP_ICON @li wxDisplaySize
wxICON @li wxDisplaySizeMM
::wxMakeMetafilePlaceable @li wxDROP_ICON
::wxSetCursor @li wxICON
@li wxMakeMetafilePlaceable
@li wxSetCursor
@section page_func_cat_printer Printer settings @section page_func_cat_printer Printer settings
NB: These routines are obsolete and should no longer be used!
The following functions are used to control PostScript printing. Under Windows, PostScript output can only be sent to a file. NB: These routines are obsolete and should no longer be used!
Include files
<wx/dcps.h> The following functions are used to control PostScript printing.
::wxGetPrinterCommand Under Windows, PostScript output can only be sent to a file.
::wxGetPrinterFile
::wxGetPrinterMode @header{wx/dcps.h}
::wxGetPrinterOptions
::wxGetPrinterOrientation @li wxGetPrinterCommand
::wxGetPrinterPreviewCommand @li wxGetPrinterFile
::wxGetPrinterScaling @li wxGetPrinterMode
::wxGetPrinterTranslation @li wxGetPrinterOptions
::wxSetPrinterCommand @li wxGetPrinterOrientation
::wxSetPrinterFile @li wxGetPrinterPreviewCommand
::wxSetPrinterMode @li wxGetPrinterScaling
::wxSetPrinterOptions @li wxGetPrinterTranslation
::wxSetPrinterOrientation @li wxSetPrinterCommand
::wxSetPrinterPreviewCommand @li wxSetPrinterFile
::wxSetPrinterScaling @li wxSetPrinterMode
::wxSetPrinterTranslation @li wxSetPrinterOptions
@li wxSetPrinterOrientation
@li wxSetPrinterPreviewCommand
@li wxSetPrinterScaling
@li wxSetPrinterTranslation
@section page_func_cat_clipboard Clipboard functions @section page_func_cat_clipboard Clipboard functions
These clipboard functions are implemented for Windows only. The use of these functions is deprecated and the code is no longer maintained. Use the wxClipboard class instead.
Include files These clipboard functions are implemented for Windows only.
<wx/clipbrd.h> The use of these functions is deprecated and the code is no longer maintained.
::wxClipboardOpen Use the wxClipboard class instead.
::wxCloseClipboard
::wxEmptyClipboard @header{wx/clipbrd.h}
::wxEnumClipboardFormats
::wxGetClipboardData @li wxClipboardOpen
::wxGetClipboardFormatName @li wxCloseClipboard
::wxIsClipboardFormatAvailable @li wxEmptyClipboard
::wxOpenClipboard @li wxEnumClipboardFormats
::wxRegisterClipboardFormat @li wxGetClipboardData
::wxSetClipboardData @li wxGetClipboardFormatName
@li wxIsClipboardFormatAvailable
@li wxOpenClipboard
@li wxRegisterClipboardFormat
@li wxSetClipboardData
@section page_func_cat_misc Miscellaneous functions and macros @section page_func_cat_misc Miscellaneous functions and macros
::wxBase64Decode
::wxBase64DecodedSize @li wxBase64Decode
::wxBase64Encode @li wxBase64DecodedSize
::wxBase64EncodedSize @li wxBase64Encode
::wxGetKeyState @li wxBase64EncodedSize
::wxNewId @li wxGetKeyState
::wxRegisterId @li wxNewId
::wxDDECleanUp @li wxRegisterId
::wxDDEInitialize @li wxDDECleanUp
::wxEnableTopLevelWindows @li wxDDEInitialize
::wxFindMenuItemId @li wxEnableTopLevelWindows
::wxFindWindowByLabel @li wxFindMenuItemId
::wxFindWindowByName @li wxFindWindowByLabel
::wxFindWindowAtPoint @li wxFindWindowByName
::wxFindWindowAtPointer @li wxFindWindowAtPoint
::wxGetActiveWindow @li wxFindWindowAtPointer
::wxGetBatteryState @li wxGetActiveWindow
::wxGetDisplayName @li wxGetBatteryState
::wxGetPowerType @li wxGetDisplayName
::wxGetMousePosition @li wxGetPowerType
::wxGetMouseState @li wxGetMousePosition
::wxGetStockLabel @li wxGetMouseState
::wxGetTopLevelParent @li wxGetStockLabel
::wxLaunchDefaultBrowser @li wxGetTopLevelParent
::wxLoadUserResource @li wxLaunchDefaultBrowser
::wxPostDelete @li wxLoadUserResource
::wxPostEvent @li wxPostDelete
::wxSetDisplayName @li wxPostEvent
::wxStripMenuCodes @li wxSetDisplayName
@li wxStripMenuCodes
@section page_func_cat_log Log functions @section page_func_cat_log Log functions
These functions provide a variety of logging functions: see Log classes overview for further information. 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).
Include files These functions provide a variety of logging functions: see @ref overview_log for
<wx/log.h> further information. The functions use (implicitly) the currently active log target,
::wxDebugMsg so their descriptions here may not apply if the log target is not the standard one
::wxError (installed by wxWidgets in the beginning of the program).
::wxFatalError
::wxLogError @header{wx/log.h}
::wxLogFatalError
::wxLogWarning @li wxDebugMsg
::wxLogMessage @li wxError
::wxLogVerbose @li wxFatalError
::wxLogStatus @li wxLogError
::wxLogSysError @li wxLogFatalError
::wxLogDebug @li wxLogWarning
::wxLogTrace @li wxLogMessage
::wxSafeShowMessage @li wxLogVerbose
::wxSysErrorCode @li wxLogStatus
::wxSysErrorMsg @li wxLogSysError
WXTRACE @li wxLogDebug
WXTRACELEVEL @li wxLogTrace
::wxTrace @li wxSafeShowMessage
::wxTraceLevel @li wxSysErrorCode
@li wxSysErrorMsg
@li wxTrace
@li wxTraceLevel
@section page_func_cat_time Time functions @section page_func_cat_time Time functions
The functions in this section deal with getting the current time and sleeping for the specified time interval.
::wxGetLocalTime The functions in this section deal with getting the current time and sleeping
::wxGetLocalTimeMillis for the specified time interval.
::wxGetUTCTime
::wxMicroSleep @li wxGetLocalTime
::wxMilliSleep @li wxGetLocalTimeMillis
::wxNow @li wxGetUTCTime
::wxSleep @li wxMicroSleep
::wxUsleep @li wxMilliSleep
@li wxNow
@li wxSleep
@li wxUsleep
@section page_func_cat_debug Debugging macros and functions @section page_func_cat_debug Debugging macros and functions
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.
Include files Useful macros and functions for error checking and defensive programming.
<wx/debug.h> wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL
::wxOnAssert macros only do anything if __WXDEBUG__ is defined (in other words, in the debug build)
::wxTrap but disappear completely in the release build. On the other hand, the wxCHECK macros
::wxIsDebuggerRunning 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}
@li wxOnAssert
@li wxTrap
@li wxIsDebuggerRunning
@section page_func_cat_env Environment access functions @section page_func_cat_env Environment access functions
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).
Include files The functions in this section allow to access (get) or change value of environment
<wx/utils.h> variables in a portable way. They are currently implemented under Win32 and
wxGetenv POSIX-like systems (Unix).
wxGetEnv
wxSetEnv @header{wx/utils.h}
wxUnsetEnv
@li wxGetenv
@li wxGetEnv
@li wxSetEnv
@li wxUnsetEnv
@section page_func_cat_atomic Atomic operation functions @section page_func_cat_atomic Atomic operation functions
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). When using multi-threaded applications, it is often required to access or modify
You should define your variable with the type wxAtomicInt in order to apply atomic operations to it. memory which is shared between threads. Atomic integer and pointer operations are
Include files an efficient way to handle this issue (another, less efficient, way is to use a mutex
<wx/atomic.h> or critical section). A native implementation exists for Windows, Linux, Solaris and
::wxAtomicInc Mac OS X, for other OS, a wxCriticalSection is used to protect the data.
::wxAtomicDec
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}
@li wxAtomicInc
@li wxAtomicDec
*/ */

13
docs/doxygen/mainpages/cat_macros.h
View File

@@ -73,7 +73,14 @@
@li wxSTRINGIZE_T @li wxSTRINGIZE_T
@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING @li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING
@li __WXFUNCTION__ @li __WXFUNCTION__
@li wxS
@li wxT
@li wxTRANSLATE
@li _
@li wxPLURAL
@li _T
@li WXTRACE
@li WXTRACELEVEL
@section page_macro_cat_byteorder Byte order macros @section page_macro_cat_byteorder Byte order macros
@@ -106,7 +113,7 @@
general you shouldn't need to use the functions and the macros in this section 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. unless you are thinking of modifying or adding any wxWidgets classes.
@seealso @sa
@ref overview_rtti @ref overview_rtti
@li CLASSINFO @li CLASSINFO
@@ -133,7 +140,7 @@
@li wx_truncate_cast @li wx_truncate_cast
@section page_macro_cat_debugging Debugging macros and functions @section page_macro_cat_debugging Debugging macros
Useful macros and functions for error checking and defensive programming. Useful macros and functions for error checking and defensive programming.
wxWidgets defines three families of the assert-like macros: the wxASSERT wxWidgets defines three families of the assert-like macros: the wxASSERT

4
docs/doxygen/mainpages/devtips.h
View File

@@ -203,7 +203,7 @@
as well). as well).
The macros handling bit-swapping with respect to the applications endianness The macros handling bit-swapping with respect to the applications endianness
are described in the @ref byteordermacros section. are described in the @ref page_macro_cat_byteorder section.
@@ -305,7 +305,7 @@
Of course, there are also 3rd party utilities such as @c dos2unix and @c unix2dos Of course, there are also 3rd party utilities such as @c dos2unix and @c unix2dos
which do the EOL conversions. which do the EOL conversions.
See also the @ref filefunctions section of the reference See also the @ref page_func_cat_file section of the reference
manual for the description of miscellaneous file handling functions. manual for the description of miscellaneous file handling functions.
*/ */

6
docs/doxygen/mainpages/strategies.h
View File

@@ -54,7 +54,7 @@
@subsection page_strategies_portability_usesizers Use sizers @subsection page_strategies_portability_usesizers Use sizers
Don't use absolute panel item positioning if you can avoid it. Different GUIs have Don't use absolute panel item positioning if you can avoid it. Different GUIs have
very differently sized panel items. Consider using the @ref overview_sizers instead. very differently sized panel items. Consider using the @ref overview_sizer instead.
@subsection page_strategies_portability_useresources Use wxWidgets resource files @subsection page_strategies_portability_useresources Use wxWidgets resource files
@@ -102,7 +102,7 @@
@subsection page_strategies_debug_uselogging Use logging functions @subsection page_strategies_debug_uselogging Use logging functions
There is a variety of logging functions that you can use in your program: There is a variety of logging functions that you can use in your program:
see @ref logfunctions. see @ref page_func_cat_log.
Using tracing statements may be more convenient than using the debugger Using tracing statements may be more convenient than using the debugger
in some circumstances (such as when your debugger doesn't support a lot in some circumstances (such as when your debugger doesn't support a lot
@@ -116,7 +116,7 @@
configured. Depending on the operating system and compiler, more or less configured. Depending on the operating system and compiler, more or less
specific information about the problem will be logged. specific information about the problem will be logged.
You should also use @ref debugmacros as part of a `defensive programming' strategy, You should also use @ref page_macro_cat_debugging as part of a `defensive programming' strategy,
scattering wxASSERTs liberally to test for problems in your code as early as possible. scattering wxASSERTs liberally to test for problems in your code as early as possible.
Forward thinking will save a surprising amount of time in the long run. Forward thinking will save a surprising amount of time in the long run.

9
docs/doxygen/overviews/debugging.h
View File

@@ -11,7 +11,7 @@
@page overview_debugging Debugging overview @page overview_debugging Debugging overview
Classes, functions and macros: wxDebugContext, wxObject, wxLog, Classes, functions and macros: wxDebugContext, wxObject, wxLog,
@ref overview_logfunctions, @ref overview_debugmacros @ref page_func_cat_log, @ref page_macro_cat_debugging
Various classes, functions and macros are provided in wxWidgets to help you debug Various classes, functions and macros are provided in wxWidgets to help you debug
your application. Most of these are only available if you compile both wxWidgets, your application. Most of these are only available if you compile both wxWidgets,
@@ -73,8 +73,9 @@
@section overview_debugging_dbgmacros Debug macros @section overview_debugging_dbgmacros Debug macros
You should also use @ref debugmacros_overview as part of a 'defensive programming' strategy, You should also use @ref page_macro_cat_debugging as part of a 'defensive programming'
scattering wxASSERTs liberally to test for problems in your code as early as possible. strategy, scattering wxASSERTs liberally to test for problems in your code as early as
possible.
Forward thinking will save a surprising amount of time in the long run. Forward thinking will save a surprising amount of time in the long run.
#wxASSERT is used to pop up an error message box when a condition #wxASSERT is used to pop up an error message box when a condition
@@ -97,7 +98,7 @@
@section overview_debugging_logging Logging functions @section overview_debugging_logging Logging functions
You can use the #wxLogDebug and #wxLogTrace functions to output debugging information in You can use the wxLogDebug and wxLogTrace functions to output debugging information in
debug mode; it will do nothing for non-debugging code. debug mode; it will do nothing for non-debugging code.

2
docs/doxygen/overviews/dialog.h
View File

@@ -22,7 +22,7 @@
until the dialog box is dismissed. until the dialog box is dismissed.
For a set of dialog convenience functions, including file selection, see For a set of dialog convenience functions, including file selection, see
@ref overview_dialogfunctions. @ref page_func_cat_dialog.
See also wxTopLevelWindow and wxWindow for inherited See also wxTopLevelWindow and wxWindow for inherited
member functions. Validation of data in controls is covered in @ref overview_validator. member functions. Validation of data in controls is covered in @ref overview_validator.

2
docs/doxygen/overviews/envvars.h
View File

@@ -17,7 +17,7 @@
@itemdef{WXTRACE, @itemdef{WXTRACE,
(Debug build only.) (Debug build only.)
This variable can be set to a comma-separated list of trace masks used in This variable can be set to a comma-separated list of trace masks used in
#wxLogTrace calls; wxLog::AddTraceMask is called for every mask wxLogTrace calls; wxLog::AddTraceMask is called for every mask
in the list during wxWidgets initialization.} in the list during wxWidgets initialization.}
@itemdef{WXPREFIX, @itemdef{WXPREFIX,
(Unix only.) (Unix only.)

2
docs/doxygen/overviews/file.h
View File

@@ -12,7 +12,7 @@
Classes: wxFile, wxDir, wxTempFile, wxTextFile Classes: wxFile, wxDir, wxTempFile, wxTextFile
Functions: see @ref filefunctions_overview. Functions: see @ref page_func_cat_file.
wxWidgets provides some functions and classes to facilitate working with files. wxWidgets provides some functions and classes to facilitate working with files.
As usual, the accent is put on cross-platform features which explains, for As usual, the accent is put on cross-platform features which explains, for