Doxygen API Reference¶
A full class-and-member reference, generated from the source-code comments under
hipo4/, is planned but not yet wired into the build. There is no Doxyfile in the
repository today, and no doc target in meson.build, so the
auto-generated HTML is not currently published alongside this site.
In the meantime, use the hand-written API pages. They cover the methods you actually call from user code, grouped by class:
| Module | Pages |
|---|---|
| Core data structures | bank, event, schema, record |
| File I/O | reader, writer, chain |
| Helpers | utilities |
For a full picture of how these classes interact, the Architecture and Data model pages are usually a better starting point than walking the class list.
Contributing
If you'd like to enable Doxygen generation, the natural place to add it is a
meson.build custom_target that runs doxygen Doxyfile, plus a CI step that
copies the generated HTML into a sub-path like public/doxygen/full/ (not
public/doxygen/ directly — that URL is owned by this placeholder page). Link to
the generated index from the top of this file once it exists.