escape underscores introduced by the last change

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

diff --git a/docs/latex/wx/stackwalker.tex b/docs/latex/wx/stackwalker.tex
index 33e495d5343ff1ccdbf5dba26f695c35ba7acae9..90f7eb5c124986e9d952b731c78da215330fe7e2 100644 (file)
--- a/docs/latex/wx/stackwalker.tex
+++ b/docs/latex/wx/stackwalker.tex
@@ -5,20 +5,20 @@
 %% 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}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxStackWalker}}\label{wxstackwalker}
 

-wxStackWalker allows to enumerate, or walk, the stack frames or, in other
-words, the functions callstack. It is mostly useful in only two situations:
+wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack).
+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.
 
 assert.
 

-wxStackWalker works by repeatedly calling 
-\helpref{OnStackFrame}{wxstackwalkeronstackframe} method for each frame in the
+wxStackWalker works by repeatedly calling
+the \helpref{OnStackFrame}{wxstackwalkeronstackframe} method for each frame in the

 stack, so to use it you must derive your own class from it and override this
 method.
 
 stack, so to use it you must derive your own class from it and override this
 method.
 


@@ -46,6 +46,10 @@ No base class
 
 <wx/stackwalk.h>
 
 
 <wx/stackwalk.h>
 

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

 Only available if \texttt{wxUSE\_STACKWALKER} is $1$, currently only
 implemented for Win32 and Unix versions using recent version of GNU libc.
 
 Only available if \texttt{wxUSE\_STACKWALKER} is $1$, currently only
 implemented for Win32 and Unix versions using recent version of GNU libc.
 


@@ -82,19 +86,23 @@ 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}
 
 
 \membersection{wxStackWalker::WalkFromException}\label{wxstackwalkerwalkfromexception}
 

-\func{void}{WalkFromException}{\void}
+\func{void}{WalkFromException}{\param{size\_t }{maxDepth = 200}}

 
 Enumerate stack frames from the location of uncaught exception.
 
 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}.
 

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