basic doxygen setup for Alepha

2024-02-01 20:59:19 -05:00
parent 9183514469
commit 985da4d921
3 changed files with 2679 additions and 0 deletions
@@ -1,2 +1,3 @@
 *.o
 Alepha
+DoxyAlepha
@@ -0,0 +1,18 @@
+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 porjetc brief and project logo in doxygen config
+- customize header and footer