Setup Doxygen

BobSaidHi · BobSaidHi · commit 74baf9fef85e · 2026-01-25T02:46:14.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 .vscode/c_cpp_properties.json
 .vscode/launch.json
 .vscode/ipch
+/docs/doxygen-out
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,22 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build API Docs (Windows)",
+            "type": "shell",
+            "command": ".\\docs\\Docs_RunDoxygen.bat",
+        },
+        {
+            "label": "Build & Open API Docs (Windows)",
+            "type": "shell",
+            "command": ".\\docs\\Docs_RunDoxygenOpen.bat",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        }
+    ]
+}
diff --git a/docs/Docs_RunDoxygen.bat b/docs/Docs_RunDoxygen.bat
@@ -0,0 +1,4 @@
+@echo Generating Documentation
+
+"C:\Program Files\doxygen\bin\doxygen.exe" ".\docs\config\Doxyfile"
+
diff --git a/docs/Docs_RunDoxygenOpen.bat b/docs/Docs_RunDoxygenOpen.bat
@@ -0,0 +1,7 @@
+@echo Generating Documentation
+
+"C:\Program Files\doxygen\bin\doxygen.exe" ".\docs\config\Doxyfile"
+
+@echo Opening HTML documentation in browser...
+.\docs\doxygen-out\html\index.html
+
diff --git a/docs/OpenGeneratedHTMLDocs.bat b/docs/OpenGeneratedHTMLDocs.bat
@@ -0,0 +1,3 @@
+@echo Opening HTML documentation in browser...
+.\docs\generated\html\index.html
+
diff --git a/docs/config/Doxyfile b/docs/config/Doxyfile

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +@echo Generating Documentation
++
 +"C:\Program Files\doxygen\bin\doxygen.exe" ".\docs\config\Doxyfile"
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@echo Opening HTML documentation in browser...`
	`2`	`+.\docs\generated\html\index.html`
	`3`	`+`