added the static function GetLabelText() to wxStaticText which was mentioned in the...

[wxWidgets.git] / docs / latex / wx / debugcxt.tex

diff --git a/docs/latex/wx/debugcxt.tex b/docs/latex/wx/debugcxt.tex
index 6e34ed172e5a24f9579ced0a8474710c3f1fbb72..ae38e3e81557ae94d76c7b92ac53de908a6c2c61 100644 (file)
--- a/docs/latex/wx/debugcxt.tex
+++ b/docs/latex/wx/debugcxt.tex
@@ -2,7 +2,7 @@
 
 A class for performing various debugging and memory tracing
 operations. Full functionality (such as printing out objects
 
 A class for performing various debugging and memory tracing
 operations. Full functionality (such as printing out objects

-currently allocated) is only present in a debugging build of wxWindows,
+currently allocated) is only present in a debugging build of wxWidgets,

 i.e. if the \_\_WXDEBUG\_\_ symbol is defined. wxDebugContext
 and related functions and macros can be compiled out by setting
 wxUSE\_DEBUG\_CONTEXT to 0 is setup.h
 i.e. if the \_\_WXDEBUG\_\_ symbol is defined. wxDebugContext
 and related functions and macros can be compiled out by setting
 wxUSE\_DEBUG\_CONTEXT to 0 is setup.h


@@ -15,6 +15,10 @@ No parent class.
 
 <wx/memory.h>
 
 
 <wx/memory.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \overview{Overview}{wxdebugcontextoverview}
 \wxheading{See also}
 
 \overview{Overview}{wxdebugcontextoverview}


@@ -44,14 +48,14 @@ derived instance.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the function succeeded, FALSE otherwise.
+true if the function succeeded, false otherwise.

 
 \membersection{wxDebugContext::GetCheckPrevious}\label{wxdebugcontextgetcheckprevious}
 
 \func{bool}{GetCheckPrevious}{\void}
 
 
 \membersection{wxDebugContext::GetCheckPrevious}\label{wxdebugcontextgetcheckprevious}
 
 \func{bool}{GetCheckPrevious}{\void}
 

-Returns TRUE if the memory allocator checks all previous memory blocks for errors.
-By default, this is FALSE since it slows down execution considerably.
+Returns true if the memory allocator checks all previous memory blocks for errors.
+By default, this is false since it slows down execution considerably.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -61,7 +65,7 @@ By default, this is FALSE since it slows down execution considerably.
 
 \func{bool}{GetDebugMode}{\void}
 
 
 \func{bool}{GetDebugMode}{\void}
 

-Returns TRUE if debug mode is on. If debug mode is on, the wxObject new and delete
+Returns true if debug mode is on. If debug mode is on, the wxObject new and delete

 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 
 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 


@@ -110,7 +114,7 @@ This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
 
 \func{bool}{HasStream}{\void}
 
 
 \func{bool}{HasStream}{\void}
 

-Returns TRUE if there is a stream currently associated
+Returns true if there is a stream currently associated

 with the debug context.
 
 This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
 with the debug context.
 
 This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.


@@ -132,7 +136,7 @@ and whether instances of this class can be dynamically created.
 
 \membersection{wxDebugContext::PrintStatistics}\label{wxdebugcontextprintstatistics}
 
 
 \membersection{wxDebugContext::PrintStatistics}\label{wxdebugcontextprintstatistics}
 

-\func{bool}{PrintStatistics}{\param{bool}{ detailed = TRUE}}
+\func{bool}{PrintStatistics}{\param{bool}{ detailed = true}}

 
 Performs a statistics analysis from the currently set checkpoint, writing
 to the current debug stream. The number of object and non-object
 
 Performs a statistics analysis from the currently set checkpoint, writing
 to the current debug stream. The number of object and non-object


@@ -140,7 +144,7 @@ allocations is printed, together with the total size.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{detailed}{If TRUE, the function will also print how many
+\docparam{detailed}{If true, the function will also print how many

 objects of each class have been allocated, and the space taken by
 these class instances.}
 
 objects of each class have been allocated, and the space taken by
 these class instances.}
 


@@ -150,7 +154,7 @@ these class instances.}
 
 \membersection{wxDebugContext::SetCheckpoint}\label{wxdebugcontextsetcheckpoint}
 
 
 \membersection{wxDebugContext::SetCheckpoint}\label{wxdebugcontextsetcheckpoint}
 

-\func{void}{SetCheckpoint}{\param{bool}{ all = FALSE}}
+\func{void}{SetCheckpoint}{\param{bool}{ all = false}}

 
 Sets the current checkpoint: Dump and PrintStatistics operations will
 be performed from this point on. This allows you to ignore allocations
 
 Sets the current checkpoint: Dump and PrintStatistics operations will
 be performed from this point on. This allows you to ignore allocations


@@ -158,7 +162,7 @@ that have been performed up to this point.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{all}{If TRUE, the checkpoint is reset to include all
+\docparam{all}{If true, the checkpoint is reset to include all

 memory allocations since the program started.}
 
 \membersection{wxDebugContext::SetCheckPrevious}\label{wxdebugcontextsetcheckprevious}
 memory allocations since the program started.}
 
 \membersection{wxDebugContext::SetCheckPrevious}\label{wxdebugcontextsetcheckprevious}


@@ -166,7 +170,7 @@ memory allocations since the program started.}
 \func{void}{SetCheckPrevious}{\param{bool}{ check}}
 
 Tells the memory allocator to check all previous memory blocks for errors.
 \func{void}{SetCheckPrevious}{\param{bool}{ check}}
 
 Tells the memory allocator to check all previous memory blocks for errors.

-By default, this is FALSE since it slows down execution considerably.
+By default, this is false since it slows down execution considerably.

 
 \wxheading{See also}
 
 
 \wxheading{See also}