Doxygen

Build code docs

Description

This action updates the Code Docs.

NeoMutt’s code is throughly commented using Doxygen comment blocks.
(Every function, struct, enum, global, and most members are documented)

Learn more about Doxygen

/**
 * mutt_path_basename - Find the last component for a pathname
 * @param str String to be examined
 * @retval ptr Part of pathname after last '/' character
 */

Steps:

  • Validate the Doxygen headers
  • Generate docs
  • Commit to docs repo
  • Push to docs repo

Action Details

Key Description Details
Trigger Schedule Mondays at 3am
Trigger Workflow (manual) https://github.com/neomutt/neomutt/actions/workflows/doxygen.yml
Uses GitHub’s checkout action https://github.com/actions/checkout
Uses Pablo Morelli’s container push action https://github.com/pmorelli92/github-container-registry-build-push
Secret Personal Access Token DOXYGEN_DEPLOY_KEY
Runs-on debian:sid (for latest version of doxygen)

See Also

Description Location
Action https://github.com/neomutt/neomutt/blob/main/.github/workflows/doxygen.yml
Action Logs https://github.com/neomutt/neomutt/actions/workflows/doxygen.yml
Source Code https://github.com/neomutt/neomutt
Scripts https://github.com/neomutt/action-doxygen
Docs Repo https://github.com/neomutt/code
Results Code Docs

Search by Algolia