Skip to content

C++ API Reference

The C++ API is documented via Doxygen.

Generate

cd tile_compile_cpp
doxygen Doxyfile

Requires doxygen and graphviz (for diagrams):

# Ubuntu/Debian
sudo apt install doxygen graphviz

# macOS
brew install doxygen graphviz

# Windows
choco install doxygen.portable graphviz

Output

HTML documentation is generated to doc/api/cpp/html/.

Open doc/api/cpp/html/index.html in a browser.

Coverage

  • Core pipeline (src/)
  • Runner applications (apps/)
  • Public headers (include/)

Key namespaces: - tile_compile::core — pipeline phases - tile_compile::registration — alignment - tile_compile::reconstruction — tile-based reconstruction