Skip to content

Doxygen

Reads which Doxygen generated a documentation site. Every HTML page Doxygen writes says so — <meta name="generator" content="Doxygen 1.19.0"/>, <!-- Generated by Doxygen 1.19.0 --> and the footer — and the probe takes the version from the first two. The page read is / unless the target’s path says otherwise. Default scheme is https.

targets:
- id: api-docs
product: doxygen
address: https://docs.example.com
path: /docs/ # optional, when the site isn't served at /

There is no Doxygen server to ask: the version recorded is the one the docs were last built with — which is what flags a stale docs pipeline. A docs site behind SSO (an oauth2-proxy login page, say) shows no mark and fails as unsupported; for a site behind HTTP Basic, configure a credential (below).

Optional — only for a site behind HTTP Basic. basic is the one kind accepted; since 2.2.0 any other kind is a config error (see Configuration → Credentials).

credentials:
docs-basic:
kind: basic
username: reader
password: "${DOCS_PASSWORD}"

Only version — e.g. 1.19.0; this probe records no extra fields.

Matched against NVD when a cve: block is configured.

github:doxygen/doxygen — endoflife.date has no Doxygen calendar (confirmed 404), so this resolves against GitHub Releases instead: the latest published, non-prerelease tag only, with no eol/support/lts dates (GitHub has no opinion on lifecycle policy, only “what’s the latest release”). Doxygen tags its releases Release_1_18_0; since 2.2.0 the github resolver reads that spelling as 1.18.0.