Přeskočit na hlavní obsah

Artefakt Doxygen

Přenosná binární distribuce nástroje Doxygen, generátoru dokumentace pro C, C++ a další jazyky. Tento repozitář využívá Artifact Handler platformy Embedbits k vyhledání, stažení, ověření a konfiguraci Doxygenu v navazujících embedded projektech.

Tento repozitář je podle rolí rozdělen na tři větve/refy — větev main (master), kterou právě čtete, obsahuje pouze tuto dokumentaci; skripty handleru jsou ve větvi Core a verzované binárky jsou publikovány jako GitHub Releases ukotvené ve větvi Bin.

Obsah repozitáře​

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 v platformě​

Tento repozitář je jednou z několika distribucí artefaktů v rámci platformy Embedbits. Celkový tok vypadá takto:

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)

Skripty ve stylu DoxygenImporter.sh publikují každou verzi Doxygenu jako GitHub Release — označený tagem Bin/<version>-<platform> — a nikoli jako soubor commitnutý do větve Bin. Samotná větev Bin nese pouze prázdné kotvicí commity, na které tagy vydání ukazují.

Platform Artifact Handler v navazujících projektech odkazuje na větev Core jako na Git submodul. Při konfiguraci CMake přečte ArtifactConfig.cmake, aby zjistil, které vydání stáhnout, a poté stáhne a ověří odpovídající asset vydání pro aktuální platformu.

Struktura větví​

Větev / RefObsah
main / masterPouze tento README — žádný funkční obsah
CoreSkripty CMake handleru (ArtifactConfig.cmake, CMakeDoxygenDefaults.cmake) a pomocné skripty pro použití artefaktu
BinPouze kotvicí větev — nejsou zde commitovány žádné binárky
Release tag Bin/<version>-<platform>GitHub Release obsahující vlastní binární .zip a soubor s kontrolním součtem .hash jako assety vydání, pro platform ∈ Win, Unix, DarwinARM

Poznámka: Samotný protokol Embedbits Artifact Handleru není na GitHub Releases vázán — takto jednoduše publikují binárky importní skripty hostované na GitHubu. Na Git hostingu bez ekvivalentního Releases API handler podporuje také zabalené binárky commitnuté přímo jako sledované soubory ve větvi Bin, označené tagem podle verze/platformy (Bin/<version>-<platform>), místo nahrání jako assety vydání. CMake handler obě varianty zpracuje transparentně.

⚠️ Stažení vydání​

Binárky nejsou uloženy jako sledované soubory ve větvi Bin — naklonujte větev Core pro skripty handleru a binárky stahujte jako assety vydání pro konkrétní tag namísto klonování větve Bin.

# 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.*"

Zahrnuté komponenty​

KomponentaPopis
doxygenHlavní spustitelný soubor pro generování dokumentace v HTML, LaTeX a PDF
doxyindexer, doxysearch.cgiVolitelné nástroje pro indexaci vyhledávání
Doxyfile.inVýchozí šablona konfigurace Doxygenu

Použití​

Artefakt se instaluje automaticky během fáze nastavení artefaktů pomocí:

cmake -P Artifacts/Doxygen/ArtifactConfig.cmake

Skript zajistí, že je binárka Doxygenu dostupná, v případě potřeby rozbalí archiv a přidá nástroj do systémové proměnné PATH pro následující kroky buildu.

Přidání cest do dokumentace​

Zahrnutí aktuálního adresáře a jeho podadresářů do vstupu Doxygenu:

Doxygen_AddPath(${CMAKE_CURRENT_LIST_DIR})

Vyloučení aktuálního adresáře a jeho podadresářů ze vstupu Doxygenu:

Doxygen_AddIgnorePath(${CMAKE_CURRENT_LIST_DIR})

Generované výstupní adresáře​

${PROJECT_ROOT}/docs/html
${PROJECT_ROOT}/docs/latex

Verzování​

Verze artefaktů přímo odpovídají oficiálním verzím vydání Doxygenu:

1.9.7, 1.9.8, 1.10.0, 1.11.0, ...

Nové verze publikuje importní skript ve stylu NinjaImporter.sh v repozitáři GithubArtifactsHandler, který stáhne oficiální binárky, zabalí je do archivů .zip s ověřením SHA-256 a publikuje je jako GitHub Release označený tagem Bin/<version>-<platform> — samotná větev Bin postupuje dál pouze prázdným kotvicím commitem, na který tag ukazuje.

Poznámky​

  • Není nutná instalace — binárky jsou přenosné a soběstačné.
  • Offline použití je podporováno, jakmile je artefakt lokálně v cache.
  • V pipelines Azure DevOps se doporučuje cachovat složku artefaktu, aby se zkrátila doba buildu.

Licence​

Doxygen je distribuován pod licencí GNU General Public License (GPL). Podrobnosti: https://www.doxygen.nl/license.html

Autoři​

Příspěvky jsou vítány! Otevřete prosím pull request.