Doxygen (#1142)

* use doxygen
* add documenting guide based on https://github.com/zeldaret/oot/blob/main/docs/Documenting.md
* exclude stdlib readme from doxygen
* refuse to configure matching iQue on macOS (EGCS compiler is not built for macOS, so iQue won't build. We still enable iQue builds on macOS by using gcc-papermario via --non-matching.)
* use proper doxygen bug comment style
* document common EVT API funcs nicely
* add doxygen ci
* add \vars command

.github/workflows/docs.yaml

@@ -0,0 +1,31 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+jobs:
+  doxygen:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Doxygen
+        run: sudo apt-get install doxygen
+      - name: Generate docs
+        run: doxygen
+      # deploy to gh pages if repo is pmret/papermario
+      - name: Deploy to gh-pages
+        if: github.repository != 'pmret/papermario'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/html
+      - name: Deploy to papermar.io
+        if: github.repository == 'pmret/papermario'
+        uses: appleboy/scp-action@master
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          source: "docs/html/"
+          target: "/var/www/papermar.io/html/docs"
+          strip_components: 2

.vscode/settings.json

@@ -50,14 +50,14 @@
     },
     "C_Cpp.autoAddFileAssociations": false,
     "C_Cpp.default.cStandard": "c89",
+    "C_Cpp.doxygen.generateOnType": false,
     "files.exclude": {
         "**/.git": true,
         "**/.splat_cache": true,
         ".ninja*": true,
         "ver/current": true,
         "expected": true,
-        "**/*.i": true,
-        "docs/doxygen": true
+        "**/*.i": true
     },
     "[python]": {
         "editor.formatOnType": true,