feature: docfx

Author: GreemDev

.github/workflows/docfx.yml

@@ -0,0 +1,42 @@
+name: Deploy Docs
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - 'master'
+    paths:
+      - 'docs/**'
+      - 'src/**'
+  workflow_dispatch:
+    inputs: {}
+jobs:
+  build:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5    
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v5
+      with:
+        dotnet-version: 10.0.x
+
+    - name: Setup DocFX
+      run: dotnet tool install -g docfx --version 2.78.5
+
+    - name: Build Gommon docs
+      run: docfx docs/docfx.json
+
+    - name: Push to the gh-pages branch
+      uses: cpina/github-action-push-to-another-repository@main
+      env:
+        API_TOKEN_GITHUB: ${{ secrets.DOCFX_GITHUB_TOKEN }}
+      with:
+        source-directory: 'docs/generated'
+        destination-github-username: 'GreemDev'
+        destination-repository-name: 'Gommon'
+        user-name: "GitHub Actions on behalf of GreemDev"
+        user-email: greemdev@ryujinx.app
+        target-branch: gh-pages

.gitignore

@@ -1,5 +1,9 @@
 .idea/
 .vs/
+docs/generated
+docs/apimeta
+docs/api/*.yml
+docs/api/.manifest
 src/bin/
 src/obj/
 src/Properties/

docs/api/index.md

@@ -0,0 +1 @@
+# Gommon API Reference

docs/docfx.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../src",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "output": "apimeta"
+    }
+  ],
+  "build": {
+    "maxParallelism": 6,
+    "content": [
+      {
+        "src": "api",
+        "files": [ "index.md", "toc.yml" ],
+        "dest": "api"
+      },
+      {
+        "src": "apimeta",
+        "files": [ "**.yml" ],
+        "dest": "api"
+      },
+      {
+        "files": [ "toc.yml", "index.md" ]
+      }
+    ],
+    "resource": [],
+    "output": "generated",
+    "template": [
+      "default",
+      "modern"
+    ],
+    "globalMetadata": {
+      "_appName": "Gommon",
+      "_appTitle": "Gommon",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

docs/index.md

@@ -0,0 +1,11 @@
+---
+_layout: landing
+---
+
+# This is the **HOMEPAGE**.
+
+Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
+
+## Quick Start Notes:
+
+1. Add images to the *images* folder if the file is referencing an image.

docs/toc.yml

@@ -0,0 +1,2 @@
+- name: API
+  href: api/

src/Utils/StringUtil.cs

@@ -33,7 +33,6 @@ string rearrange(string s)
     /// </summary>
     /// <param name="length"></param>
     /// <param name="allowRepeats"></param>
-    /// <returns></returns>
     public static string RandomAlphanumeric(int length, bool allowRepeats = true)
     {
         Guard.Ensure(length > 0, "length must be at least 1");