Skip to content
SHUFFLE FrameworkSHUFFLE FrameworkDocs

API reference (generated)

The API reference is generated by Doxygen from the comments of the public headers. It will be published here with the public repositories.

Until then, build it from a shuffle_engine checkout (Doxygen 1.9 or later and Python 3):

Terminal window
doxygen docs/api/Doxyfile                       # -> docs/api/html/index.html
python tools/api_docs.py check docs/api/warnings.log

and then npm run sync-docs -- --with-api copies it into this site. How the reference is organised, and the comment rules behind it, are on the API reference page.

© 2026 Umberto Sorbo. The software is licensed under the Apache License, Version 2.0, and provided “as is”, without warranties or conditions of any kind; see the disclaimer.

SHUFFLE Framework and the SHUFFLE Framework logo are trademarks of Umberto Sorbo; the licence grants no rights to them (trademarks). Other names belong to their owners. Fonts: IBM Plex Sans and JetBrains Mono, SIL Open Font License 1.1.

Contact: shuffleframework@gmail.com · Instagram @shuffleframework. Security problems: write to the same address with “Security” in the subject, not in a public issue.