build: generate docs

.github/workflows/doc.yml

@@ -0,0 +1,42 @@
+
+name: Docs
+
+on:
+  push:
+    branches: ["master"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-page
+      url: ${{ steps.deployement.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install doxygen graphviz
+      - name: generate-docs
+        run: |
+          doxygen
+      - name: setup-pages
+        uses: actions/configure-pages@v4
+      - name: upload-artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/html'
+      - name: deploy-github-page
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+

.gitignore

@@ -28,3 +28,4 @@ src/stpdfs-fuse
 
 Debug/
 .vs/
+html/

lib/stpdfs.h

@@ -1,11 +1,16 @@
 #ifndef STPDFS_H
 # define STPDFS_H 1
 
+# include <stdint.h>
+
 #define STPDFS_MAGIC 0x44505453
 
 #define STPDFS_BLOCK_SIZE 512
 
-struct stpdfs_superblock {
+/**
+ * \brief StupidFS Superblock
+ */
+struct stpdfs_sb {
 	uint32_t magic;
 	uint32_t isize;
 	uint32_t fsize;

module/Makefile.am

@@ -5,8 +5,8 @@ MOD_DEVDIR = $(PWD)
 export module_DATA
 
 EXTRA_PROGRAMS = stpdfs_module
-stpdfs_module_SOURCES = module_stpdfs.c 
-module_DATA = module_stpdfs.o 
+stpdfs_module_SOURCES = module.c 
+module_DATA = module.o 
 
 $(module_DATA): $(stpdfs_module_SOURCES) 
 	mv Makefile Makefile.automake 

module/module.c

@@ -1,6 +1,15 @@
+/**
+ * \addtogroup driver
+ * @{
+ */
 #include <linux/init.h>
 #include <linux/module.h>
 
+/**
+ * \defgroup linux Linux Kernel Module
+ * @{
+ */
+
 static int __init
 stpdfs_mod_init(void)
 {
@@ -18,7 +27,9 @@ stpdfs_mod_exit(void)
 
 module_exit(stpdfs_mod_exit);
 
-MODULE_LICENSE("BSD3");
+MODULE_LICENSE("CECILL-B or BSD3");
 MODULE_AUTHOR("d0p1");
 MODULE_DESCRIPTION("Stupid File System");
 MODULE_VERSION("1.0");
+
+/** @} @} */

win32/driver.c

@@ -1,6 +1,15 @@
+/**
+ * \addtogroup driver
+ * @{
+ */
 #include <ntddk.h>
 #include <wdf.h>
 
+/**
+ * \defgroup win32 Windows Driver
+ * @{
+ */
+
 DRIVER_INITIALIZE DriverEntry;
 
 PDEVICE_OBJECT StpdDiskFileSystemDeviceObject;
@@ -43,3 +52,5 @@ DriverEntry(
 #pragma prefast(pop)
     return status;
 }
+
+/** @} @} */