ThrowTheSwitch/cexception
1
0
Fork 0
mirror of https://github.com/throwtheswitch/cexception.git synced 2026-09-11 04:39:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation so it matches the code

Browse Source
This commit is contained in:
Chris
2022-08-17 17:23:53 +02:00
committed by GitHub
parent 1eece6133d
commit 37b7758e28
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 of these are optional. You could directly include `CException.h` if
you wanted and just use the defaults provided. 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'. * 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`. * 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 * If in a multi-tasking environment, this should be
set to be a call to the function described in #2 above. set to be a call to the function described in #2 above.
Defaults to just return `0` all the time (good for Defaults to just return `0` all the time (good for
single tasking environments) single tasking environments)
* `EXCEPTION_NUM_ID` * `CEXCEPTION_NUM_ID`
* If in a multi-tasking environment, this should be set * If in a multi-tasking environment, this should be set
to the number of ID's required (usually the number of to the number of ID's required (usually the number of
tasks in the system). Defaults to `1` (for single tasks in the system). Defaults to `1` (for single