some cleanups and clarifications to documentation just added, suggested by Alexander Malmberg

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@19817 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Adrian Robert 2004-08-02 18:10:58 +00:00
parent 1e37b28748
commit 966b2cb0c9
10 changed files with 51 additions and 30 deletions

View file

@ -88,11 +88,9 @@ typedef struct _NSHandler
} NSHandler;
/**
* This is the exception handler called when an exception is generated and
* not caught by the programmer (by enclosing in <code>NS_DURING</code> and
* <code>NS_HANDLER</code>...<code>NS_ENDHANDLER</code>). It prints an error
* message and exits the program. You can change this behavior by calling
* <code>NSSetUncaughtExceptionHandler(fn_ptr)</code>.
* This is the type of the exception handler called when an exception is
* generated and not caught by the programmer. See
* NSGetUncaughtExceptionHandler(), NSSetUncaughtExceptionHandler().
*/
typedef void NSUncaughtExceptionHandler(NSException *exception);
@ -101,7 +99,23 @@ typedef void NSUncaughtExceptionHandler(NSException *exception);
* function NSSetUncaughtExceptionHandler() to set.
*/
GS_EXPORT NSUncaughtExceptionHandler *_NSUncaughtExceptionHandler;
/**
* Returns the exception handler called when an exception is generated and
* not caught by the programmer (by enclosing in <code>NS_DURING</code> and
* <code>NS_HANDLER</code>...<code>NS_ENDHANDLER</code>). The default prints
* an error message and exits the program. You can change this behavior by
* calling NSSetUncaughtExceptionHandler().
*/
#define NSGetUncaughtExceptionHandler() _NSUncaughtExceptionHandler
/**
* Sets the exception handler called when an exception is generated and
* not caught by the programmer (by enclosing in <code>NS_DURING</code> and
* <code>NS_HANDLER</code>...<code>NS_ENDHANDLER</code>). The default prints
* an error message and exits the program. proc should take a single argument
* of type <code>NSException *</code>.
*/
#define NSSetUncaughtExceptionHandler(proc) \
(_NSUncaughtExceptionHandler = (proc))