Skip to content

C++ API reference

The C++ API reference is auto-generated from the source code using Doxygen and doxybook2.

Generating the API docs

Prerequisites:

  • Doxygen ≥ 1.9
  • doxybook2 ≥ 1.5

Steps:

# 1. Generate XML from Doxygen
doxygen docs/Doxyfile

# 2. Convert XML to Markdown
doxybook2 --input build/doxygen/xml --output docs/api --config docs/doxybook2.json

The Markdown files land under docs/api/ and are picked up automatically by MkDocs when you run mkdocs build or mkdocs serve.

CMake convenience target

If you configured with -DLINCE_BUILD_DOCS=ON:

cmake --build build --target docs

This runs Doxygen + doxybook2 + mkdocs build in a single step.

Note

The API reference is not committed to the repository. It is generated on demand during the documentation build so that it always stays in sync with the current source tree.