quesa/Development/Source/Core/Support E3StackCrawl.h,1.5,1.6

[James W. W. <jww...@us...>]

Update of /cvsroot/quesa/quesa/Development/Source/Core/Support
In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv11770/quesa/Development/Source/Core/Support

Modified Files:
	E3StackCrawl.h 
Log Message:
Improved comments.

Index: E3StackCrawl.h
===================================================================
RCS file: /cvsroot/quesa/quesa/Development/Source/Core/Support/E3StackCrawl.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** E3StackCrawl.h	28 Apr 2004 22:04:39 -0000	1.5
--- E3StackCrawl.h	31 Mar 2008 21:04:48 -0000	1.6
***************
*** 11,15 ****
  
      COPYRIGHT:
!         Copyright (c) 1999-2004, Quesa Developers. All rights reserved.
  
          For the current release of Quesa, please see:
--- 11,15 ----
  
      COPYRIGHT:
!         Copyright (c) 1999-2008, Quesa Developers. All rights reserved.
  
          For the current release of Quesa, please see:
***************
*** 74,80 ****
  	@typedef	TQ3StackCrawl
  	
! 	@discussion	This is an opaque pointer type holding a list of function names
! 				of a stack crawl.  Some time in the future, we might want to
! 				record additional information such as addresses.
  */
  typedef struct TQ3StackCrawlRec*	TQ3StackCrawl;
--- 74,80 ----
  	@typedef	TQ3StackCrawl
  	
! 	@discussion	This is an opaque pointer type holding a stack crawl.  Depending
! 				on platform and implementation, it might hold numerical
! 				addresses or symbol strings.
  */
  typedef struct TQ3StackCrawlRec*	TQ3StackCrawl;
***************
*** 109,112 ****
--- 109,114 ----
  	@function	E3StackCrawl_Get
  	@abstract	Get a function name out of a stack crawl.
+ 	@discussion	The string returned by this function should be regarded as
+ 				read-only and temporary.
  	@param		inCrawl		A stack crawl created by <code>E3StackCrawl_New</code>.
  	@param		inIndex		An index, at least 0 and less than the result of