我想让我的代码中的文档尽可能可读,但我也希望使用Doxygen自动生成文档。
然后我想用Markdown语法在我的代码中编写文档,但是我没有找到如何在Doxygen中添加Markdown支持。
This page没有解释如何添加支持,而Doxyfile中的MARKDOWN_SUPPORT = YES没有任何效果。
我正在使用Ubuntu 12.04和Doxygen 1.7。
编辑1:
“并保留原始文件扩展名”添加到标题
我的问题来自我用于代码的扩展程序。我保留.h和.cpp扩展名,而.md则需要启用markdown。是否可以使用markdown并保留原始的.h和.cpp扩展名?
编辑2:
这是一个示例代码(test.h):
/**
* Title test
* ==========
* @file test.h
*
* | This | is | a | table |
* | :----:| :----: | :----:| :----:|
* | x | x | x | x |
*/
由于命令@file,结果包含Doxygen中的文件,但生成的html文件将标题和表格显示为普通文本。
答案 0 :(得分:3)
我意识到我没有像我最初想的那样使用Doxygen 1.8.5而是使用Doxygen 1.7。 Doxygen 1.7(在Ubuntu存储库中提供)不会在Doxygen 1.8.5时自动支持Markdown。
然后我必须手动安装Doxygen 1.8.5(64位版本here)并使用this solution解决了安装问题。
现在Doxygen本身支持Markdown。