|
@@ -100,7 +100,7 @@ prefix is used.
|
|
|
Options to compile with debug symbols are available.
|
|
Options to compile with debug symbols are available.
|
|
|
|
|
|
|
|
|
|
|
|
|
-### Compile-Time Constants
|
|
|
|
|
|
|
+### Compile-Time defines (`-D[...]`)
|
|
|
|
|
|
|
|
`DEBUG`: Set debug mode: memory map is at reduced size, logging is forced to
|
|
`DEBUG`: Set debug mode: memory map is at reduced size, logging is forced to
|
|
|
TRACE level, etc.
|
|
TRACE level, etc.
|
|
@@ -151,7 +151,9 @@ systems. The map size by itself does not use up any extra resources.
|
|
|
|
|
|
|
|
### C API Documentation
|
|
### C API Documentation
|
|
|
|
|
|
|
|
-*TODO* Almost all header files are documented. Need a doc generator.
|
|
|
|
|
|
|
+Almost all header files are documented. Run `doxygen` (see
|
|
|
|
|
+[Doxygen](https://www.doxygen.nl/index.html)) to generate HTML documentation in
|
|
|
|
|
+`docs/html`.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Python API Documentation
|
|
### Python API Documentation
|
