Documentation Standards
When providing code for WW4 it will be required to provide documentation as annotation in all source code files using doxygen and its in-code documentation tags. This will be the foundation of automated documentation generation. doxygen can be downloaded for free from the website https://www.doxygen.nl/.
System documentation will be exclusively online and directly associated with and maintained with doxigen in the repository. All additional documentation such as a traditional manual and quick start guide will be published in wiki format as part of the repository, and some of these may be published as traditional pdf (or even LaTeX) based documents, in particular for formal model releases. The latter decision will be made as the code reaches maturity for its first release.
Presently we are not enforcing doxygen documentation standards within the GitHub workflow. We intend to do so once we have a more mature approach for online WW4 documentation. Note that the required documentation with doxygen is outlined in the AGENTS.md file in the root directory of the repository. Hence, creating documentation tags is effectively automated if you use Agentic AI to develop your code in combination with the WW4 AGENTS.md file.
