Doxygen

Build code docs

Description

This action updates the Code Docs.

NeoMutt’s code is thoroughly 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)	neomutt/neomutt
Uses	GitHub’s checkout action	actions/checkout
Uses	Pablo Morelli’s container push action	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	neomutt/neomutt
Action Logs	neomutt/neomutt
Source Code	neomutt/neomutt
Scripts	neomutt/action-doxygen
Docs Repo	neomutt/code
Results	Code Docs