Don't use const bool.

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

diff --git a/docs/latex/wx/stackwalker.tex b/docs/latex/wx/stackwalker.tex
index 3d827f4818c4957a8782e5923027a9fa5a1ad044..562e80eb760a9996c729fa8dc4b182e1a8eac54b 100644 (file)
--- a/docs/latex/wx/stackwalker.tex
+++ b/docs/latex/wx/stackwalker.tex
@@ -5,16 +5,16 @@
 %% Created:     2005-01-19
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2005 Vadim Zeitlin
 %% Created:     2005-01-19
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2005 Vadim Zeitlin

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxStackWalker}}\label{wxstackwalker}
 
 wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack).
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxStackWalker}}\label{wxstackwalker}
 
 wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack).

-It is mostly useful in only two situations: 
+It is mostly useful in only two situations:

 inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to
 inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to

-programmatically get the location of the crash and, in debug builds, in 
-\helpref{wxApp::OnAssert}{wxapponassert} to report the caller of the failed
+programmatically get the location of the crash and, in debug builds, in
+\helpref{wxApp::OnAssertFailure}{wxapponassertfailure} to report the caller of the failed

 assert.
 
 wxStackWalker works by repeatedly calling
 assert.
 
 wxStackWalker works by repeatedly calling


@@ -82,19 +82,21 @@ This function must be overrided to process the given frame.
 
 \membersection{wxStackWalker::Walk}\label{wxstackwalkerwalk}
 
 
 \membersection{wxStackWalker::Walk}\label{wxstackwalkerwalk}
 

-\func{void}{Walk}{\param{size\_t }{skip = 1}}
+\func{void}{Walk}{\param{size\_t }{skip = 1}, \param{size\_t }{maxDepth = 200}}

 
 Enumerate stack frames from the current location, skipping the initial
 number of them (this can be useful when Walk() is called from some known
 location and you don't want to see the first few frames anyhow; also
 notice that Walk() frame itself is not included if skip $\ge 1$).
 
 
 Enumerate stack frames from the current location, skipping the initial
 number of them (this can be useful when Walk() is called from some known
 location and you don't want to see the first few frames anyhow; also
 notice that Walk() frame itself is not included if skip $\ge 1$).
 

+Up to \arg{maxDepth} frames are walked from the innermost to the outermost one.
+

 
 \membersection{wxStackWalker::WalkFromException}\label{wxstackwalkerwalkfromexception}
 
 \func{void}{WalkFromException}{\void}
 
 Enumerate stack frames from the location of uncaught exception.
 
 \membersection{wxStackWalker::WalkFromException}\label{wxstackwalkerwalkfromexception}
 
 \func{void}{WalkFromException}{\void}
 
 Enumerate stack frames from the location of uncaught exception.

-This method can only be called from 
+This method can only be called from

 \helpref{wxApp::OnFatalException()}{wxapponfatalexception}.
 
 \helpref{wxApp::OnFatalException()}{wxapponfatalexception}.