From 29d21088bb00fd99d669a00136185c0f1b972634 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Wed, 5 Mar 2008 19:08:53 +0000 Subject: [PATCH] fixed all doxygen warnings fixable git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52339 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile.inc | 7 +- docs/doxygen/mainpages/cat_classes.h | 20 +- docs/doxygen/mainpages/cat_functions.h | 562 ++++++++++++++----------- docs/doxygen/mainpages/cat_macros.h | 13 +- docs/doxygen/mainpages/devtips.h | 4 +- docs/doxygen/mainpages/strategies.h | 6 +- docs/doxygen/overviews/debugging.h | 9 +- docs/doxygen/overviews/dialog.h | 2 +- docs/doxygen/overviews/envvars.h | 2 +- docs/doxygen/overviews/file.h | 2 +- 10 files changed, 351 insertions(+), 276 deletions(-) diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc index c641af62d4..6c72a4082d 100644 --- a/docs/doxygen/Doxyfile.inc +++ b/docs/doxygen/Doxyfile.inc @@ -62,7 +62,7 @@ ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n" ALIASES += endExtraStyleTable="\n" # 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 += stdobjects="\section class_stdobj Predefined objects\n \b" 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, # 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.... +# 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 += wxheader{1}="\headerfile \1 wx/\1" # some formatting aliases # NOTE: using and 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 #--------------------------------------------------------------------------- -INPUT = ./mainpages ./overviews ../../interface +INPUT = ./mainpages ./overviews #../../interface INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h *.txt RECURSIVE = YES diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index e915d91e4c..8cf4025f14 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -15,18 +15,18 @@ @beginInvisibleTable - @li @ref page_class_cat_manwnd + @li @ref page_class_cat_managedwnd @li @ref page_class_cat_miscwnd @li @ref page_class_cat_cmndlg @li @ref page_class_cat_ctrl @li @ref page_class_cat_miscpickers @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_dc @li @ref page_class_cat_gdi @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_containers @li @ref page_class_cat_smartpointers @@ -38,12 +38,12 @@ @li @ref page_class_cat_ipc @li @ref page_class_cat_dvf @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_streams @li @ref page_class_cat_threading @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_vfs @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 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 interface with built-in docking, floatable panes and a flexible @@ -346,7 +346,7 @@ @li wxWizardEvent: A wizard event - @section page_class_cat_val Validators + @section page_class_cat_validator Validators @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 @@ -630,7 +630,7 @@ @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 and paragraph formatting. diff --git a/docs/doxygen/mainpages/cat_functions.h b/docs/doxygen/mainpages/cat_functions.h index 346ddb1c81..a4fd7125dc 100644 --- a/docs/doxygen/mainpages/cat_functions.h +++ b/docs/doxygen/mainpages/cat_functions.h @@ -20,7 +20,7 @@ @li @ref page_func_cat_networkuseros @li @ref page_func_cat_string @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_printer @li @ref page_func_cat_clipboard @@ -38,290 +38,354 @@ @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. -::wxEntry -::wxEntryCleanup -::wxEntryStart -::wxGetApp -::wxHandleFatalExceptions -::wxInitAllImageHandlers -::wxInitialize -::wxSafeYield -::wxUninitialize -::wxYield -::wxWakeUpIdle + 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. + + @li wxEntry + @li wxEntryCleanup + @li wxEntryStart + @li wxGetApp + @li wxHandleFatalExceptions + @li wxInitAllImageHandlers + @li wxInitialize + @li wxSafeYield + @li wxUninitialize + @li wxYield + @li wxWakeUpIdle @section page_func_cat_procctrl Process control functions -The functions in this section are used to launch or terminate the other processes. -::wxExecute -::wxExit -::wxJoin -::wxKill -::wxGetProcessId -::wxShell -::wxShutdown + + The functions in this section are used to launch or terminate the other processes. + + @li wxExecute + @li wxExit + @li wxJoin + @li wxKill + @li wxGetProcessId + @li wxShell + @li wxShutdown + @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 - -See also -wxThread, wxMutex, Multithreading overview -::wxIsMainThread -::wxMutexGuiEnter -::wxMutexGuiLeave + 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 + + @li wxIsMainThread + @li wxMutexGuiEnter + @li wxMutexGuiLeave + @section page_func_cat_file File functions -Include files - -See also -wxPathList -wxDir -wxFile -wxFileName - -::wxDos2UnixFilename -::wxFileExists -::wxFileModificationTime -::wxFileNameFromPath -::wxFindFirstFile -::wxFindNextFile -::wxGetDiskSpace -::wxGetFileKind -::wxGetOSDirectory -::wxIsAbsolutePath -::wxDirExists -::wxPathOnly -::wxUnix2DosFilename -::wxConcatFiles -::wxCopyFile -::wxGetCwd -::wxGetWorkingDirectory -::wxGetTempFileName -::wxIsWild -::wxMatchWild -::wxMkdir -::wxParseCommonDialogsFilter -::wxRemoveFile -::wxRenameFile -::wxRmdir -::wxSetWorkingDirectory -::wxSplit -::wxSplitPath -::wxTransferFileToStream -::wxTransferStreamToFile + + @header{wx/filefn.h} + + @sa + wxPathList, wxDir, wxFile, wxFileName + + @li wxDos2UnixFilename + @li wxFileExists + @li wxFileModificationTime + @li wxFileNameFromPath + @li wxFindFirstFile + @li wxFindNextFile + @li wxGetDiskSpace + @li wxGetFileKind + @li wxGetOSDirectory + @li wxIsAbsolutePath + @li wxDirExists + @li wxPathOnly + @li wxUnix2DosFilename + @li wxConcatFiles + @li wxCopyFile + @li wxGetCwd + @li wxGetWorkingDirectory + @li wxGetTempFileName + @li wxIsWild + @li wxMatchWild + @li wxMkdir + @li wxParseCommonDialogsFilter + @li wxRemoveFile + @li wxRenameFile + @li wxRmdir + @li wxSetWorkingDirectory + @li wxSplit + @li wxSplitPath + @li wxTransferFileToStream + @li wxTransferStreamToFile + @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 -::wxGetFreeMemory -::wxGetFullHostName -::wxGetHomeDir -::wxGetHostName -::wxGetOsDescription -::wxGetOsVersion -::wxIsPlatformLittleEndian -::wxIsPlatform64Bit -::wxGetUserHome -::wxGetUserId -::wxGetUserName + + The functions in this section are used to retrieve information about the current + computer and/or user characteristics. + + @li wxGetEmailAddress + @li wxGetFreeMemory + @li wxGetFullHostName + @li wxGetHomeDir + @li wxGetHostName + @li wxGetOsDescription + @li wxGetOsVersion + @li wxIsPlatformLittleEndian + @li wxIsPlatform64Bit + @li wxGetUserHome + @li wxGetUserId + @li wxGetUserName @section page_func_cat_string String functions -::wxGetTranslation -::wxIsEmpty -wxS -::wxStrcmp -::wxStricmp -::wxStringEq -::wxStringMatch -::wxStringTokenize -::wxStrlen -::wxSnprintf -wxT -wxTRANSLATE -::wxVsnprintf -_ -wxPLURAL -_T + + @li wxGetTranslation + @li wxIsEmpty + @li wxStrcmp + @li wxStricmp + @li wxStringEq + @li wxStringMatch + @li wxStringTokenize + @li wxStrlen + @li wxSnprintf + @li wxVsnprintf + @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 -::wxBeginBusyCursor -::wxBell -::wxCreateFileTipProvider -::wxDirSelector -::wxFileSelector -::wxEndBusyCursor -::wxGenericAboutBox -::wxGetColourFromUser -::wxGetFontFromUser -::wxGetMultipleChoices -::wxGetNumberFromUser -::wxGetPasswordFromUser -::wxGetTextFromUser -::wxGetSingleChoice -::wxGetSingleChoiceIndex -::wxGetSingleChoiceData -::wxInfoMessageBox -::wxIsBusy -::wxMessageBox -::wxShowTip + + 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. + + @li wxAboutBox + @li wxBeginBusyCursor + @li wxBell + @li wxCreateFileTipProvider + @li wxDirSelector + @li wxFileSelector + @li wxEndBusyCursor + @li wxGenericAboutBox + @li wxGetColourFromUser + @li wxGetFontFromUser + @li wxGetMultipleChoices + @li wxGetNumberFromUser + @li wxGetPasswordFromUser + @li wxGetTextFromUser + @li wxGetSingleChoice + @li wxGetSingleChoiceIndex + @li wxGetSingleChoiceData + @li wxInfoMessageBox + @li wxIsBusy + @li wxMessageBox + @li wxShowTip + @section page_func_cat_math Math functions -Include files - -wxFinite -wxIsNaN + + @header{wx/math.h} + + @li wxFinite + @li wxIsNaN + @section page_func_cat_gdi GDI functions -The following are relevant to the GDI (Graphics Device Interface). -Include files - -wxBITMAP -::wxClientDisplayRect -::wxColourDisplay -::wxDisplayDepth -::wxDisplaySize -::wxDisplaySizeMM -::wxDROP_ICON -wxICON -::wxMakeMetafilePlaceable -::wxSetCursor + + The following are relevant to the GDI (Graphics Device Interface). + + @header{gdicmn.h} + + @li wxBITMAP + @li wxClientDisplayRect + @li wxColourDisplay + @li wxDisplayDepth + @li wxDisplaySize + @li wxDisplaySizeMM + @li wxDROP_ICON + @li wxICON + @li wxMakeMetafilePlaceable + @li wxSetCursor + @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. -Include files - -::wxGetPrinterCommand -::wxGetPrinterFile -::wxGetPrinterMode -::wxGetPrinterOptions -::wxGetPrinterOrientation -::wxGetPrinterPreviewCommand -::wxGetPrinterScaling -::wxGetPrinterTranslation -::wxSetPrinterCommand -::wxSetPrinterFile -::wxSetPrinterMode -::wxSetPrinterOptions -::wxSetPrinterOrientation -::wxSetPrinterPreviewCommand -::wxSetPrinterScaling -::wxSetPrinterTranslation + + 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. + + @header{wx/dcps.h} + + @li wxGetPrinterCommand + @li wxGetPrinterFile + @li wxGetPrinterMode + @li wxGetPrinterOptions + @li wxGetPrinterOrientation + @li wxGetPrinterPreviewCommand + @li wxGetPrinterScaling + @li wxGetPrinterTranslation + @li wxSetPrinterCommand + @li wxSetPrinterFile + @li wxSetPrinterMode + @li wxSetPrinterOptions + @li wxSetPrinterOrientation + @li wxSetPrinterPreviewCommand + @li wxSetPrinterScaling + @li wxSetPrinterTranslation + @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 - -::wxClipboardOpen -::wxCloseClipboard -::wxEmptyClipboard -::wxEnumClipboardFormats -::wxGetClipboardData -::wxGetClipboardFormatName -::wxIsClipboardFormatAvailable -::wxOpenClipboard -::wxRegisterClipboardFormat -::wxSetClipboardData + + 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. + + @header{wx/clipbrd.h} + + @li wxClipboardOpen + @li wxCloseClipboard + @li wxEmptyClipboard + @li wxEnumClipboardFormats + @li wxGetClipboardData + @li wxGetClipboardFormatName + @li wxIsClipboardFormatAvailable + @li wxOpenClipboard + @li wxRegisterClipboardFormat + @li wxSetClipboardData + @section page_func_cat_misc Miscellaneous functions and macros -::wxBase64Decode -::wxBase64DecodedSize -::wxBase64Encode -::wxBase64EncodedSize -::wxGetKeyState -::wxNewId -::wxRegisterId -::wxDDECleanUp -::wxDDEInitialize -::wxEnableTopLevelWindows -::wxFindMenuItemId -::wxFindWindowByLabel -::wxFindWindowByName -::wxFindWindowAtPoint -::wxFindWindowAtPointer -::wxGetActiveWindow -::wxGetBatteryState -::wxGetDisplayName -::wxGetPowerType -::wxGetMousePosition -::wxGetMouseState -::wxGetStockLabel -::wxGetTopLevelParent -::wxLaunchDefaultBrowser -::wxLoadUserResource -::wxPostDelete -::wxPostEvent -::wxSetDisplayName -::wxStripMenuCodes + + @li wxBase64Decode + @li wxBase64DecodedSize + @li wxBase64Encode + @li wxBase64EncodedSize + @li wxGetKeyState + @li wxNewId + @li wxRegisterId + @li wxDDECleanUp + @li wxDDEInitialize + @li wxEnableTopLevelWindows + @li wxFindMenuItemId + @li wxFindWindowByLabel + @li wxFindWindowByName + @li wxFindWindowAtPoint + @li wxFindWindowAtPointer + @li wxGetActiveWindow + @li wxGetBatteryState + @li wxGetDisplayName + @li wxGetPowerType + @li wxGetMousePosition + @li wxGetMouseState + @li wxGetStockLabel + @li wxGetTopLevelParent + @li wxLaunchDefaultBrowser + @li wxLoadUserResource + @li wxPostDelete + @li wxPostEvent + @li wxSetDisplayName + @li wxStripMenuCodes @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 - -::wxDebugMsg -::wxError -::wxFatalError -::wxLogError -::wxLogFatalError -::wxLogWarning -::wxLogMessage -::wxLogVerbose -::wxLogStatus -::wxLogSysError -::wxLogDebug -::wxLogTrace -::wxSafeShowMessage -::wxSysErrorCode -::wxSysErrorMsg -WXTRACE -WXTRACELEVEL -::wxTrace -::wxTraceLevel + + These functions provide a variety of logging functions: see @ref overview_log 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). + + @header{wx/log.h} + + @li wxDebugMsg + @li wxError + @li wxFatalError + @li wxLogError + @li wxLogFatalError + @li wxLogWarning + @li wxLogMessage + @li wxLogVerbose + @li wxLogStatus + @li wxLogSysError + @li wxLogDebug + @li wxLogTrace + @li wxSafeShowMessage + @li wxSysErrorCode + @li wxSysErrorMsg + @li wxTrace + @li wxTraceLevel + @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 -::wxGetLocalTimeMillis -::wxGetUTCTime -::wxMicroSleep -::wxMilliSleep -::wxNow -::wxSleep -::wxUsleep + + The functions in this section deal with getting the current time and sleeping + for the specified time interval. + + @li wxGetLocalTime + @li wxGetLocalTimeMillis + @li wxGetUTCTime + @li wxMicroSleep + @li wxMilliSleep + @li wxNow + @li wxSleep + @li wxUsleep @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 - -::wxOnAssert -::wxTrap -::wxIsDebuggerRunning + + 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} + + @li wxOnAssert + @li wxTrap + @li wxIsDebuggerRunning + @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 - -wxGetenv -wxGetEnv -wxSetEnv -wxUnsetEnv + + 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} + + @li wxGetenv + @li wxGetEnv + @li wxSetEnv + @li wxUnsetEnv + @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). -You should define your variable with the type wxAtomicInt in order to apply atomic operations to it. -Include files - -::wxAtomicInc -::wxAtomicDec + + 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} + + @li wxAtomicInc + @li wxAtomicDec */ \ No newline at end of file diff --git a/docs/doxygen/mainpages/cat_macros.h b/docs/doxygen/mainpages/cat_macros.h index f8d689704b..d13dba262b 100644 --- a/docs/doxygen/mainpages/cat_macros.h +++ b/docs/doxygen/mainpages/cat_macros.h @@ -73,7 +73,14 @@ @li wxSTRINGIZE_T @li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING @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 @@ -106,7 +113,7 @@ 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. - @seealso + @sa @ref overview_rtti @li CLASSINFO @@ -133,7 +140,7 @@ @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. wxWidgets defines three families of the assert-like macros: the wxASSERT diff --git a/docs/doxygen/mainpages/devtips.h b/docs/doxygen/mainpages/devtips.h index b6c7e88c1e..239e7a6d07 100644 --- a/docs/doxygen/mainpages/devtips.h +++ b/docs/doxygen/mainpages/devtips.h @@ -203,7 +203,7 @@ as well). 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 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. */ diff --git a/docs/doxygen/mainpages/strategies.h b/docs/doxygen/mainpages/strategies.h index d9046e38fe..6a589a9c8a 100644 --- a/docs/doxygen/mainpages/strategies.h +++ b/docs/doxygen/mainpages/strategies.h @@ -54,7 +54,7 @@ @subsection page_strategies_portability_usesizers Use sizers 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 @@ -102,7 +102,7 @@ @subsection page_strategies_debug_uselogging Use logging functions 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 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 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. Forward thinking will save a surprising amount of time in the long run. diff --git a/docs/doxygen/overviews/debugging.h b/docs/doxygen/overviews/debugging.h index 80c447b7a9..273704b070 100644 --- a/docs/doxygen/overviews/debugging.h +++ b/docs/doxygen/overviews/debugging.h @@ -11,7 +11,7 @@ @page overview_debugging Debugging overview 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 your application. Most of these are only available if you compile both wxWidgets, @@ -73,8 +73,9 @@ @section overview_debugging_dbgmacros Debug macros - You should also use @ref debugmacros_overview as part of a 'defensive programming' strategy, - scattering wxASSERTs liberally to test for problems in your code as early as possible. + 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. 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 @@ -97,7 +98,7 @@ @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. diff --git a/docs/doxygen/overviews/dialog.h b/docs/doxygen/overviews/dialog.h index 691736e40b..ff78186c95 100644 --- a/docs/doxygen/overviews/dialog.h +++ b/docs/doxygen/overviews/dialog.h @@ -22,7 +22,7 @@ until the dialog box is dismissed. 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 member functions. Validation of data in controls is covered in @ref overview_validator. diff --git a/docs/doxygen/overviews/envvars.h b/docs/doxygen/overviews/envvars.h index 49df4e772c..05bfc6a081 100644 --- a/docs/doxygen/overviews/envvars.h +++ b/docs/doxygen/overviews/envvars.h @@ -17,7 +17,7 @@ @itemdef{WXTRACE, (Debug build only.) 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.} @itemdef{WXPREFIX, (Unix only.) diff --git a/docs/doxygen/overviews/file.h b/docs/doxygen/overviews/file.h index 838f8cecc9..c9dbb67f34 100644 --- a/docs/doxygen/overviews/file.h +++ b/docs/doxygen/overviews/file.h @@ -12,7 +12,7 @@ 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. As usual, the accent is put on cross-platform features which explains, for -- 2.45.2