diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Doxyfile | 25 | ||||
| -rw-r--r-- | docs/src/goals.dox | 4 | ||||
| -rw-r--r-- | docs/src/jitter.dox | 2 |
3 files changed, 5 insertions, 26 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 143360dc9..04b07a496 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1289,30 +1289,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = __DOXYGEN__ \ - CH_USE_WAITEXIT \ - CH_USE_SEMAPHORES \ - CH_USE_SEMSW \ - CH_USE_SEMAPHORES_TIMEOUT \ - CH_USE_MUTEXES \ - CH_USE_CONDVARS \ - CH_USE_CONDVARS_TIMEOUT \ - CH_USE_EVENTS \ - CH_USE_EVENTS_TIMEOUT \ - CH_USE_EXIT_EVENT \ - CH_USE_QUEUES \ - CH_USE_QUEUES_TIMEOUT \ - CH_USE_QUEUES_HALFDUPLEX \ - CH_USE_SERIAL_FULLDUPLEX \ - CH_USE_SERIAL_HALFDUPLEX \ - CH_USE_HEAP \ - CH_USE_MEMPOOLS \ - CH_USE_MESSAGES \ - CH_USE_MESSAGES_EVENT \ - CH_USE_DEBUG \ - CH_USE_TRACE \ - CH_USE_DYNAMIC \ - CH_USE_ROUNDROBIN +PREDEFINED = __DOXYGEN__ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/docs/src/goals.dox b/docs/src/goals.dox index 3a2209f0c..13e764802 100644 --- a/docs/src/goals.dox +++ b/docs/src/goals.dox @@ -64,8 +64,8 @@ * can report memory exhausted.
*
* <h3>Very simple APIs</h3>
- * Every API should have the parameters you would expect for that function, no
- * more no less. Each API does a single thing with no options.
+ * Each API should have the parameters you would expect for that function and
+ * do just one thing with no options.
*
* <h3>Fast and compact</h3>
* Note, first "fast" then "compact", the focus is on speed and execution
diff --git a/docs/src/jitter.dox b/docs/src/jitter.dox index d0215abb2..bff39bed6 100644 --- a/docs/src/jitter.dox +++ b/docs/src/jitter.dox @@ -55,6 +55,7 @@ int -> busy [label="Not Ready"];
busy -> busy [label="Still Busy\n(added latency)"];
busy -> served [label="Finally Ready"];
+ }
* @enddot
*
* In this scenario the jitter (busy state) is represented by the sum of:
@@ -85,6 +86,7 @@ busy -> busy [label="Higher priority Threads\n(added latency)"];
busy -> thread [label="Highest Priority"];
served -> thread [label="Highest Priority (minimum latency)"];
+ }
* @enddot
*
* In this scenario all the jitter sources previously discussed are also
|