Update github pages on push

.github/workflows/gh-pages.yml

@@ -0,0 +1,28 @@
+on: 
+  push:
+    branches: [master]
+
+jobs:
+  gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: install doxygen
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen
+      - name: genereate docs
+        run: |
+          doxygen
+      - name: push docs
+        run: |
+          git fetch --depth=1 origin gh-pages
+          git checkout gh-pages
+          rm -rf docs
+          mv html docs
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action (docs)"
+          git add docs
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          git commit -m 'Add docs'
+          git push origin gh-pages

Doxyfile

@@ -1061,7 +1061,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

README.md

@@ -1,6 +1,7 @@
 # Injector
 
 [![tests](https://github.com/kubo/injector/actions/workflows/test.yml/badge.svg)](https://github.com/kubo/injector/actions/workflows/test.yml)
+[![Static Badge](https://img.shields.io/badge/docs-API_reference-blue)](http://www.jiubao.org/injector/injector_8h.html)
 
 **Library for injecting a shared library into a Linux, Windows and MacOS process**
 

include/injector.h

@@ -37,7 +37,7 @@ typedef DWORD injector_pid_t;
 #include <sys/types.h>
 
 /*!
- * \brief \c pid_t on Unix. \c DWORD on Windows.
+ * \brief Platform-dependent process id type (\c pid_t on Unix. \c DWORD on Windows)
  */
 typedef pid_t injector_pid_t;
 #endif