ThrowTheSwitch/cexception
1
0
Fork 0
mirror of https://github.com/throwtheswitch/cexception.git synced 2026-06-05 21:24:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #26 from wouterscm/patch-1

Browse Source 
Fix documentation so it matches the code
This commit is contained in:
Mark VanderVoord
2022-08-17 12:17:56 -04:00
committed by GitHub
parent 0858abac8d af61b8f337
commit 3667ee2d44
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CException.md
+4 -4
View File
@@ -230,19 +230,19 @@ further requirements, then calls `CException.h` to do the gruntwork. All
of these are optional. You could directly include `CException.h` if
you wanted and just use the defaults provided.
* `EXCEPTION_T`
* `CEXCEPTION_T`
* Set this to the type you want your exception id's to be. Defaults to 'unsigned int'.
* `EXCEPTION_NONE`
* `CEXCEPTION_NONE`
* Set this to a number which will never be an exception id in your system. Defaults to `0x5a5a5a5a`.
* `EXCEPTION_GET_ID`
* `CEXCEPTION_GET_ID`
* If in a multi-tasking environment, this should be
set to be a call to the function described in #2 above.
Defaults to just return `0` all the time (good for
single tasking environments)
* `EXCEPTION_NUM_ID`
* `CEXCEPTION_NUM_ID`
* If in a multi-tasking environment, this should be set
to the number of ID's required (usually the number of
tasks in the system). Defaults to `1` (for single