C++ API reference¶

The full C++ API reference is generated by Doxygen and served as a sub-directory of this site.

What you'll find there¶

Every public function, class, struct, and enum under include/ and src/.
Inheritance and collaboration diagrams (rendered via Graphviz).
File listings linking back to GitHub for any symbol.

Coverage¶

The reference is generated with EXTRACT_ALL = YES, so it includes every declaration even when the source has no /// comments. That gives broad coverage today; PRs that touch a header should add Doxygen comments incrementally:

/**
 * @brief One-line summary.
 *
 * Longer description if necessary. Refer to the
 * [Architecture overview](../architecture/overview.md) for the bigger
 * picture.
 *
 * @param x  What this parameter is for.
 * @return   What the function returns.
 */
int my_function(int x);

JAVADOC_AUTOBRIEF = YES is set in the Doxyfile, so the first sentence becomes the brief automatically.

What's not in the reference¶

Headers under lib/C2000Ware_* are excluded — they're vendored TI register definitions and would swamp the rest of the API. For TI specifics, read the source headers directly.

The auto-generated src/checks/generated.cpp and src/checks/compare_generated.cpp are also excluded by pattern because they regenerate frequently and would churn the index. The code-generation tools that emit them are documented in the Python tools page.