Reference¶
This section contains lookup material: exact options, configuration keys, file formats, catalogs, and maps from common names to public headers. Read a tutorial first when you are learning a workflow.
Build and integration¶
Reference |
Purpose |
|---|---|
Build switches, defaults, and optional features |
|
Required and optional tools and libraries |
|
Roles, layers, headers, and examples for common API types |
|
Reading order for source-focused snippets |
|
Exact declarations, overloads, namespaces, and Doxygen comments |
Runtime configuration and data¶
Reference |
Purpose |
|---|---|
Exact JSON/TOML keys and values |
|
Raw field storage contract |
|
Symptom-oriented operational checks |
|
Typical log structure and success indicators |
Inventories and terminology¶
Reference |
Purpose |
|---|---|
Runnable targets and teaching tiers |
|
Project terminology |
Public class and function declarations are extracted from headers by Doxygen and rendered in the integrated API reference through Breathe. The prose reference pages should explain contracts and relationships rather than copy complete declarations.