stack trace fixups

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@24482 72102866-910b-0410-8b05-ffd578937521

Headers/Foundation/NSException.h

@@ -89,37 +89,37 @@ extern "C" {
 }
 
 /**
-   Create an an exception object with a name, reason and a dictionary
-   userInfo which can be used to provide additional information or
-   access to objects needed to handle the exception. After the
-   exception is created you must -raise it.
-*/
+ * Create an an exception object with a name, reason and a dictionary
+ * userInfo which can be used to provide additional information or
+ * access to objects needed to handle the exception. After the
+ * exception is created you must -raise it.
+ */
 + (NSException*) exceptionWithName: (NSString*)name
 			    reason: (NSString*)reason
 			  userInfo: (NSDictionary*)userInfo;
 
 /**
-   Creates an exception with a name and a reason using the
-   format string and any additional arguments. The exception is then
-   <em>raised</em> using the -raise method.
+ * Creates an exception with a name and a reason using the
+ * format string and any additional arguments. The exception is then
+ * <em>raised</em> using the -raise method.
  */
 + (void) raise: (NSString*)name
 	format: (NSString*)format,...;
 
 /**
-   Creates an exception with a name and a reason string using the
-   format string and additional arguments specified as a variable
-   argument list argList. The exception is then <em>raised</em>
-   using the -raise method.
+ * Creates an exception with a name and a reason string using the
+ * format string and additional arguments specified as a variable
+ * argument list argList. The exception is then <em>raised</em>
+ * using the -raise method.
  */
 + (void) raise: (NSString*)name
 	format: (NSString*)format
      arguments: (va_list)argList;
 
 /**
-   <init/>Initializes a newly allocated NSException object with a
-   name, reason and a dictionary userInfo.
-*/
+ * <init/>Initializes a newly allocated NSException object with a
+ * name, reason and a dictionary userInfo.
+ */
 - (id) initWithName: (NSString*)name 
 	     reason: (NSString*)reason 
 	   userInfo: (NSDictionary*)userInfo;
@@ -128,25 +128,31 @@ extern "C" {
 - (NSString*) name;
 
 /**
-   Raises the exception. All code following the raise will not be
-   executed and program control will be transfered to the closest
-   calling method which encapsulates the exception code in an
-   NS_DURING macro.<br />
-   If the exception was not caught in a macro, the currently set
-   uncaught exception handler is called to perform final logging
-   and the program is then terminated.<br />
-   If the uncaught exception handler fails to terminate the program,
-   then the default behavior is to terminate the program as soon as
-   the uncaught exception handler function returns.<br />
-   NB. all other exception raising methods call this one, so if you
-   want to set a breakpoint when debugging, set it in this method.
-*/
+ * Raises the exception. All code following the raise will not be
+ * executed and program control will be transfered to the closest
+ * calling method which encapsulates the exception code in an
+ * NS_DURING macro.<br />
+ * If the exception was not caught in a macro, the currently set
+ * uncaught exception handler is called to perform final logging
+ * and the program is then terminated.<br />
+ * If the uncaught exception handler fails to terminate the program,
+ * then the default behavior is to terminate the program as soon as
+ * the uncaught exception handler function returns.<br />
+ * NB. all other exception raising methods call this one, so if you
+ * want to set a breakpoint when debugging, set it in this method.
+ */
 - (void) raise;
 
 /** Returns the exception reason. */
 - (NSString*) reason;
 
-/** Returns the exception userInfo dictionary. */
+/** Returns the exception userInfo dictionary.<br />
+ * There is a GNUstep extension, enabled when the GNUSTEP_STACK_TRACE
+ * environment variable is set to YES, which causes a stack trace to
+ * be placed in this dictionary (keyed on GSStackTraceKey) at the point
+ * when the exception is raised.  This can be useful for determining
+ * where an exception ocurred.
+ */
 - (NSDictionary*) userInfo;
 
 @end