Documenting Source

TTG C/C++ source should be documented using Doxygen. Doxygen supports in-source documentation and stand-alone documents. TTG's Doxygen configuration is contained in the Doxyfile.in. TTG enables support for Markdown both in in-source comments and for Markdown pages (with .md extension). The use of Markdown is encouraged.

Administration

• Generation and deployment of TTG's documentation is performed by successful CI jobs defined here. The Build+Deploy Dox step assembles the TTG website by combining
  • the frontmatter: currently just TTG's README.md file),
  • the rest of the website content located on the gh-pages-template branch of the TTG repo
  • the Doxygen html documentation
• Dox deployment uses a GitHub token that is defined as variable GH_TTG_TOKEN in GHA's TTG repo settings' secrets.