115% line height on lists is more than enough, especially for the class hierarchy...

[wxWidgets.git] / interface / stackwalk.h

diff --git a/interface/stackwalk.h b/interface/stackwalk.h
index 0474f4e2b910ce6808acbdfe53ca3b098916f031..782b5268e5bf4350d4b2d79e077b583d636bed0d 100644 (file)
--- a/interface/stackwalk.h
+++ b/interface/stackwalk.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stackwalk.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stackwalk.h

-// Purpose:     documentation for wxStackWalker class
+// Purpose:     interface of wxStackWalker

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -43,8 +43,7 @@
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @seealso
-    wxStackFrame
+    @see wxStackFrame

 */
 class wxStackWalker
 {
 */
 class wxStackWalker
 {


@@ -71,8 +70,7 @@ public:
         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 = 1).
         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 = 1).

-        
-        Up to @e maxDepth frames are walked from the innermost to the outermost one.
+        Up to @a maxDepth frames are walked from the innermost to the outermost one.

     */
     void Walk(size_t skip = 1, size_t maxDepth = 200);
 
     */
     void Walk(size_t skip = 1, size_t maxDepth = 200);
 


@@ -80,13 +78,13 @@ public:
         Enumerate stack frames from the location of uncaught exception.
         This method can only be called from
         wxApp::OnFatalException.
         Enumerate stack frames from the location of uncaught exception.
         This method can only be called from
         wxApp::OnFatalException.

-        
-        Up to @e maxDepth frames are walked from the innermost to the outermost one.
+        Up to @a maxDepth frames are walked from the innermost to the outermost one.

     */
     void WalkFromException(size_t maxDepth = 200);
 };
 
 
     */
     void WalkFromException(size_t maxDepth = 200);
 };
 
 

+

 /**
     @class wxStackFrame
     @wxheader{stackwalk.h}
 /**
     @class wxStackFrame
     @wxheader{stackwalk.h}


@@ -99,8 +97,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @seealso
-    wxStackWalker
+    @see wxStackWalker

 */
 class wxStackFrame
 {
 */
 class wxStackFrame
 {


@@ -108,67 +105,65 @@ public:
     /**
         Return the address of this frame.
     */
     /**
         Return the address of this frame.
     */

-    void* GetAddress();
+    void* GetAddress() const;

 
     /**
         Return the name of the file containing this frame, empty if
         unavailable (typically because debug info is missing).
 
     /**
         Return the name of the file containing this frame, empty if
         unavailable (typically because debug info is missing).

-        

         Use HasSourceLocation() to check whether
         the file name is available.
     */
         Use HasSourceLocation() to check whether
         the file name is available.
     */

-    wxString GetFileName();
+    wxString GetFileName() const;

 
     /**
         Get the level of this frame (deepest/innermost one is 0).
     */
 
     /**
         Get the level of this frame (deepest/innermost one is 0).
     */

-    size_t GetLevel();
+    size_t GetLevel() const;

 
     /**
         Return the line number of this frame, 0 if unavailable.
 
     /**
         Return the line number of this frame, 0 if unavailable.

-        
-        @sa GetFileName()
+
+        @see GetFileName()

     */
     */

-    size_t GetLine();
+    size_t GetLine() const;

 
     /**
         Get the module this function belongs to (empty if not available).
     */
 
     /**
         Get the module this function belongs to (empty if not available).
     */

-    wxString GetModule();
+    wxString GetModule() const;

 
     /**
         Return the unmangled (if possible) name of the function containing this
         frame.
     */
 
     /**
         Return the unmangled (if possible) name of the function containing this
         frame.
     */

-    wxString GetName();
+    wxString GetName() const;

 
     /**
         Return the return address of this frame.
     */
 
     /**
         Return the return address of this frame.
     */

-    size_t GetOffset();
+    size_t GetOffset() const;

 
     /**
         Get the name, type and value (in text form) of the given parameter.
         Any pointer may be @NULL if you're not interested in the corresponding
         value.
 
     /**
         Get the name, type and value (in text form) of the given parameter.
         Any pointer may be @NULL if you're not interested in the corresponding
         value.

-        

         Return @true if at least some values could be retrieved.
         Return @true if at least some values could be retrieved.

-        

         This function currently is only implemented under Win32 and requires a PDB
         file.
     */
         This function currently is only implemented under Win32 and requires a PDB
         file.
     */

-    bool GetParam(size_t n, wxString * type, wxString * name,
-                  wxString * value);
+    bool GetParam(size_t n, wxString* type, wxString* name,
+                  wxString* value) const;

 
     /**
         Return the number of parameters of this function (may return 0 if we
         can't retrieve the parameters info even although the function does have
         parameters).
     */
 
     /**
         Return the number of parameters of this function (may return 0 if we
         can't retrieve the parameters info even although the function does have
         parameters).
     */

-    size_t GetParamCount();
+    size_t GetParamCount() const;

 
     /**
         Return @true if we have the file name and line number for this frame.
     */
 
     /**
         Return @true if we have the file name and line number for this frame.
     */

-    bool HasSourceLocation();
+    bool HasSourceLocation() const;

 };
 };

+