1
0
forked from Alepha/Alepha
Files
Alepha/docs/README.doxygen
ADAM David Alan Martin 6d60639b1c Move some docs to a docs dir.
This lets me have a dir named `Format`, which I want.
2024-04-04 18:12:54 -04:00

19 lines
686 B
Plaintext

To generate a doxygen reference for Alepha, run "doxygen doxyfile.alepha"
A subfolder, DoxygenAlepha, will be created
Point a browser to the html/index.html within DoxyAlepha to bring up the main page.
The .gitignore file here excludes the DoxyAlepha subfolder in its entirety.
If there are too many namespaces in the Class List, consider using Class Index instead.
Note:
Upgraded to version 1.10.0 to, hopefully get better c++20, including concepts
Todo:
- create a script to execute doxygen
- as part of that script preprocess source file (c++ and header) to remove or simplify namespaces
- set the project brief and project logo in doxygen config
- customize header and footer