Skip to content

Commit b5fff50

Browse files
committed
Better error handler function documentation.
1 parent 8b05510 commit b5fff50

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/ce/tice.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ void *os_GetSystemStats(void);
503503
* @code
504504
* int errno = os_PushErrorHandler();
505505
* if (errno) {
506-
* // handle error, but do not call os_PopErrorHandler()
506+
* // handle error, but no longer under the protection of the error handler so do not call os_PopErrorHandler()
507507
* } else {
508508
* // run some code that may error
509509
* os_PopErrorHandler();
@@ -516,8 +516,8 @@ void *os_GetSystemStats(void);
516516
int os_PushErrorHandler(void);
517517

518518
/**
519-
* Restores state after a call to os_PushErrorHandler, but should not be called along the error
520-
* path, and restores stack and ix to their state before the call to os_PushErrorHandler.
519+
* Restores stack state after a call to os_PushErrorHandler. Must be called with stack in the same state
520+
* as it was when os_PushErrorHandler returned with 0, and should not be called along the error path.
521521
*
522522
* @see os_PushErrorHandler
523523
*/

0 commit comments

Comments
 (0)