Merge pull request #64 from beman-project/add-basic-documentation

started to add Doxygen documentation

Author: dietmarkuehl

.github/workflows/doxygen-gh-pages.yml

@@ -0,0 +1,18 @@
+name: Doxygen GitHub Pages Deploy Action
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: DenverCoder1/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: docs/html

.gitignore

@@ -32,9 +32,9 @@
 *.app
 
 build
-mkerr
-olderr
 .DS_store
 .vs
 .vscode
 stagedir
+docs/html
+docs/latex

Makefile

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 SANITIZERS = release debug msan asan usan tsan
-.PHONY: default run update check ce todo distclean clean build test all format $(SANITIZERS)
+.PHONY: default doc run update check ce todo distclean clean build test all format $(SANITIZERS)
 
 COMPILER=system
 CXX_BASE=$(CXX:$(dir $(CXX))%=%)
@@ -51,6 +51,9 @@ all: $(SANITIZERS)
 run: test
 	./$(BUILD)/examples/$(EXAMPLE)
 
+doc:
+	doxygen docs/Doxyfile
+
 release: test
 
 $(SANITIZERS):