empty api documentation.

.github/workflows/generate-doc.yml

@@ -0,0 +1,58 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+# note: GitHub Actions runner images are frequently updated, and
+# unfortunately this sometimes breaks builds in mysterious ways...
+# see https://github.com/actions/runner-images.git
+
+name: CI
+
+on: [push, workflow_dispatch]
+
+env:
+  CMAKE_REQUIRED_QUIET: 'OFF'
+  CMAKE_VERBOSE_MAKEFILE: 'ON'
+  CTEST_OUTPUT_ON_FAILURE: 'ON'
+  DEBIAN_FRONTEND: noninteractive
+  UPX_CMAKE_BUILD_FLAGS: --verbose
+  UPX_CMAKE_CONFIG_FLAGS: -Wdev --warn-uninitialized
+  UPX_CONFIG_HAVE_WORKING_BUILD_RPATH: 'ON'
+  UPX_DEBUG_TEST_FLOAT_DIVISION_BY_ZERO: 1
+  UPX_DEBUG_TEST_LIBC_QSORT: 1
+  ZSTD_CLEVEL: 9
+  # 2024-08-17
+  ZIG_DIST_VERSION: 0.14.0-dev.1166+bb7050106
+
+jobs:
+  build-doc:
+    name: Rebuild stubs
+    runs-on: ubuntu-latest
+    container: ubuntu:24.04
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - name: Install packages
+        run: |
+          sudo apt install --yes doxygen graphviz
+
+      - name: Check out code
+        run: |
+          git config --global --add safe.directory '*' # needed when running in a container
+          git clone --branch "$GITHUB_REF_NAME" --depth 1 "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" .
+          git submodule update --init -- vendor/lzma-sdk
+          git fsck --strict --no-progress
+
+      - name: Build docs
+        run: |
+          make -C doc clean all
+          if ! git diff --quiet; then git diff || true; fi # ignore diff error
+          doxygen doc/doxygen-file
+
+      - uses: DenverCoder1/doxygen-github-pages-action@v2.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

README

@@ -65,6 +65,17 @@ Please see the file UPX.DOC for the full documentation. The files
 NEWS and BUGS also contain various tidbits of information.
 
 
+DEVELOPPER API DOCUMENTATION
+============================
+
+The developper api internals of upx are available at [set the url there]()
+
+Build it locally with:
+
+```bash
+doxygen doxygen-file
+```
+
 THE FUTURE
 ==========