我打算用doxygen来记录项目。这是一个OSS项目,其当前的文档质量有问题。我决定使用doxygen的原因是因为从版本1.8开始,doxygen增加了对Markdown的支持(文本格式化程序;我们也认为我们在这个网站上使用它)。
我的一个问题是那些可能最终使用旧版Doxygen的人(例如,它在当前的Ubuntu LTS版本中尚未更新)。
是否可以在Doxyfile(doxygen配置文件)中添加一些设置或标记,以便在有人尝试使用较旧版本的doxygen生成文档时发出错误/警告?
(理想情况下,也解释错误原因)
答案 0 :(得分:1)
Doxygen本身为这些情况提供了一种警告。如果您的doxyfile包含MARKDOWN_SUPPORT = YES
之类的内容并且现任doxygen不支持markdown,那么您会收到一个警告,指出该选项无法识别。
Warning: ignoring unsupported tag 'MARKDOWN_SUPPORT'...
或者,你可以实现一些解析doxygen -v
返回的脚本,它将返回一个方便的'1.8.5'或使用帮助,包括一行version 1.y.z
- 所以基于{{ {1}}会提取合适的行。