Doxygen Artifact
Portable binary distribution of Doxygen, a documentation generator for C, C++, and other languages. This repository is consumed by the Embedbits Platform Artifact Handler to locate, download, verify, and configure Doxygen in downstream embedded projects.
This repository is split into three branches/refs by role — the main (master) branch you are reading now holds only this documentation; the handler scripts live on the Core branch, and versioned binaries are published as GitHub Releases anchored to the Bin branch.
Repository contents
main / master
└── README.md ← This document — no other content
Core
├── ArtifactConfig.cmake ← Artifact metadata (name, version constraints, asset naming)
├── CMakeDoxygenDefaults.cmake ← Doxygen integration logic (path setup, input/ignore path config)
└── Doxyfile.in ← Doxygen configuration template
Bin (anchor branch — no tracked binary files)
└── (empty commits only; each release tag points here)
Role in the platform
This repository is one of several artifact distributions within the Embedbits platform. The overall flow is:
GitHub (Embedbits)
──────────────────────────────────────────────────────────
Artifact-doxygen
main / master → README only (this document)
Core → ArtifactConfig.cmake, CMakeDoxygenDefaults.cmake, Doxyfile.in
Bin → Anchor branch (empty commits)
Releases → doxygen-<version>-<platform>.zip + .hash
tagged Bin/<version>-<platform> (platform: Win / Unix / DarwinARM)
DoxygenImporter.sh-style scripts publish each Doxygen version as a GitHub Release — tagged Bin/<version>-<platform> — rather than as a file committed to the Bin branch. The Bin branch itself only carries empty anchor commits for the release tags to point at.
The Platform Artifact Handler in downstream projects references the Core branch as a Git submodule. At CMake configure time it reads ArtifactConfig.cmake to determine which release to fetch, then downloads and verifies the matching release asset for the current platform.
Branch structure
| Branch / Ref | Content |
|---|---|
main / master | This README only — no functional content |
Core | CMake handler scripts (ArtifactConfig.cmake, CMakeDoxygenDefaults.cmake) and helper scripts for consuming the artifact |
Bin | Anchor branch only — no binaries are committed here |
Release tag Bin/<version>-<platform> | GitHub Release carrying the actual .zip binary and its .hash checksum file as release assets, for platform ∈ Win, Unix, DarwinARM |
Note: The Embedbits Artifact Handler protocol itself is not tied to GitHub Releases — that is simply how the GitHub-hosted importer scripts happen to publish binaries. On a Git host without an equivalent Releases API, the handler also supports packaged binaries committed directly as tracked files on the
Binbranch, tagged per version/platform (Bin/<version>-<platform>) instead of uploaded as release assets. The CMake handler resolves either form transparently.
⚠️ Fetching a release
Binaries are not stored as tracked files in Bin — clone the Core branch for the handler scripts, and download binaries as release assets for a specific tag instead of cloning the Bin branch.
# Core handler scripts
git clone --branch Core --single-branch --depth=1 <repository_url> doxygen-core
# Binary + checksum for one specific version/platform (GitHub Release asset)
gh release download Bin/1.11.0-Unix --repo Embedbits/Artifact-doxygen --pattern "doxygen-1.11.0-Unix.*"
Included components
| Component | Description |
|---|---|
doxygen | Main executable for generating HTML, LaTeX, and PDF documentation |
doxyindexer, doxysearch.cgi | Optional tools for search indexing |
Doxyfile.in | Default Doxygen configuration template |
Usage
The artifact is installed automatically during the Artifacts setup phase via:
cmake -P Artifacts/Doxygen/ArtifactConfig.cmake
The script ensures the Doxygen binary is available, unpacks the archive if needed, and adds the tool to the system PATH for subsequent build steps.
Adding paths to documentation
Include the current directory and its subdirectories in Doxygen input:
Doxygen_AddPath(${CMAKE_CURRENT_LIST_DIR})
Exclude the current directory and its subdirectories from Doxygen input:
Doxygen_AddIgnorePath(${CMAKE_CURRENT_LIST_DIR})
Generated output directories
${PROJECT_ROOT}/docs/html
${PROJECT_ROOT}/docs/latex
Versioning
Artifact versions correspond directly to official Doxygen release versions:
1.9.7, 1.9.8, 1.10.0, 1.11.0, ...
New versions are published by the NinjaImporter.sh-style importer script in the GithubArtifactsHandler repository, which downloads the official binaries, packages them as .zip archives with SHA-256 verification, and publishes them as a GitHub Release tagged Bin/<version>-<platform> — the Bin branch itself only advances via an empty anchor commit that the tag points to.
Notes
- No installation required — binaries are portable and self-contained.
- Offline use is supported once the artifact is cached locally.
- In Azure DevOps pipelines, caching the artifact folder is recommended to reduce build time.
License
Doxygen is distributed under the GNU General Public License (GPL). For details, see: https://www.doxygen.nl/license.html
Authors
- Mr.Nobody — embedbits.com
Contributions are welcome! Please open a pull request.