2.1.23.2.3. cli.pre_commit_scripts.check_doxygen.run_check

cli.pre_commit_scripts.check_doxygen.run_check(filename: Path, version: str) int

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

Parameters:
  • filename – Path to the C file.

  • version – foxBMS version string to check in the @version field.

Returns:

Number of detected formatting or presence errors.