2.1.23.2. cli.pre_commit_scripts.check_doxygen

Check file-level Doxygen comments in C source files for correct formatting.

This script verifies that required Doxygen fields (such as @file, @author, @date, @updated, @version, @ingroup, @prefix, @brief, and @details) are present and properly formatted at the specified offsets in C source files. It is intended for use with pre-commit.

Functions

check_doxygen(files, version)

Check multiple files for correct Doxygen file-level comments.

main([argv])

Command-line interface for checking Doxygen file-level comments.

run_check(filename, version)

Run checks on a single C file for required Doxygen file-level comment fields.