如何在Doxygen中嵌入带注释和可编译的源/示例?

时间:2016-06-21 07:08:53

标签: documentation doxygen

我希望在我的软件中有一个可编辑的示例,该示例已注释,因此它可以包含在doxygen .dox中。这里的关键部分是我希望注释成为源代码的一部分(这应该是doxygen的全部要点,但似乎缺少这个简单的特性)

那么,是否可以将它包含在文本和代码混合的方式中,就像\dontinclude示例here一样?

\snippet - 似乎不太有用,因为它们需要将注释与代码分开。 \dontinclude也是如此。

我现在唯一的想法就是编写一个脚本用作预做氧步骤,该步骤解析示例源并生成带有文本和.dox块的\code文件。

1 个答案:

答案 0 :(得分:4)

嗯......我写了上面提到的脚本。

我在这里发帖,以防有问题的人有所帮助:https://gist.github.com/iboB/925542e1ed5afee2b0083ff4fa970462

gist中有一个示例用法