如何在Doxygen中用@ref引用无扩展名LICENSE文件以复用版权内容

1. 让Doxygen识别LICENSE文件 #

你的LICENSE在项目根目录，Doxyfile位于Dir-to-document/docs/，需要调整以下配置：

• INPUT：在现有INPUT配置后追加LICENSE的相对路径：../../LICENSE，确保Doxygen能扫描到该文件。
• FILE_PATTERNS：默认Doxygen不扫描无扩展名文件，需添加LICENSE到规则中，修改后示例：

  FILE_PATTERNS = *.c *.h *.dox LICENSE
  

• FOLLOW_SYMLINKS：如果想使用docs目录下的SYMLINK-TO-LICENSE，确保该配置设为YES（允许Doxygen跟随符号链接）。

2. 给LICENSE文件添加可引用标记 #

在LICENSE文件开头添加Doxygen注释标签，让它成为可引用的文档项：

/**
 * @file LICENSE
 * @brief 项目版权许可证
 */

3. 在文档中引用LICENSE #

现在可以在任意.dox文件或代码注释中用@ref引用：

• 直接引用：@ref LICENSE
• 带自定义显示文本：@ref LICENSE "查看完整版权许可证"

关键检查点 #

• 修改配置后务必重新运行Doxygen生成文档。
• 确认LICENSE文件未被你的EXCLUDE规则排除。

内容的提问来源于stack exchange，提问作者Jeff of Bread