如何通过Doxygen(Jenkins)检查文件版权声明头并生成缺失警告

一、基于Doxygen的自定义警告实现 #

Doxygen没有原生的版权声明检测选项，但可以通过以下方式模拟原生警告格式：

1. 自定义文件过滤器 #

• 编写脚本（Python/Bash均可），遍历所有待处理的代码文件，检查文件开头是否包含指定的版权特征（比如@par Copyright标记或COPYRIGHT标题块）。
• 对于缺失声明的文件，输出和Doxygen原生警告完全一致的格式：文件名:1: warning: missing copyright header（行号设为1，因为版权声明通常在文件开头）。
• 在Doxygen配置中设置FILTER_PATTERNS，让Doxygen处理每个文件前先执行该脚本，这样警告会混入Doxygen的输出日志，被Jenkins扫描器识别。

2. 结合未文档化警告与自定义命令 #

• 在所有包含版权声明的文件开头添加自定义命令，比如\copyright_marker。
• 在Doxygen配置中开启WARN_IF_UNDOCUMENTED = YES，同时通过ALIASES定义\copyright_marker为空占位符（ALIASES += "copyright_marker="）。
• 缺失该命令的文件会触发Doxygen的"文件未记录"警告，之后可以通过Jenkins扫描器筛选这类警告，或在脚本中替换警告文本为"missing copyright header"。

二、独立脚本检测（更轻量） #

如果不想改动Doxygen配置，可单独实现检测逻辑：

• 编写脚本遍历代码目录，用正则匹配两种版权格式的特征：

  # 匹配第一种版权格式
  ^\s*\*\s*@par Copyright\s*$
  # 匹配第二种版权格式
  ^\s*\*\s*COPYRIGHT\s*$
  

• 收集所有缺失版权声明的文件，输出符合Jenkins扫描器要求的警告格式（每行一条文件名: warning: missing copyright header）。
• 在Jenkins任务中先执行该脚本，再运行Doxygen，让扫描器抓取脚本输出的警告信息。

内容的提问来源于stack exchange，提问作者master2591