如何在 Doxygen 中嵌入带注释和可编译的 source/example?
How to embed an annotated and compilable source/example in Doxygen?
我想在我的软件中有一个可编译的示例,它被注释以便可以包含在 doxygen .dox
中。这里的关键部分是我希望注释成为源代码的一部分(这应该是 doxygen 的全部要点,但它似乎缺少这个简单的功能)
那么,是否有可能以一种看起来像文本和代码混合的方式包含它,就像 \dontinclude
示例 here?
\snippet
-s 似乎没有用,因为它们需要将注释与代码分开。 \dontinclude
.
也是如此
我现在唯一的想法是编写一个脚本用作 doxygen 前步骤,它解析示例源并生成 .dox
包含文本和 \code
块的文件。
嗯...我写了上面提到的脚本
我将它张贴在这里,以防对遇到同样问题的人有所帮助:https://gist.github.com/iboB/925542e1ed5afee2b0083ff4fa970462
要点中有一个示例用法
我想在我的软件中有一个可编译的示例,它被注释以便可以包含在 doxygen .dox
中。这里的关键部分是我希望注释成为源代码的一部分(这应该是 doxygen 的全部要点,但它似乎缺少这个简单的功能)
那么,是否有可能以一种看起来像文本和代码混合的方式包含它,就像 \dontinclude
示例 here?
\snippet
-s 似乎没有用,因为它们需要将注释与代码分开。 \dontinclude
.
我现在唯一的想法是编写一个脚本用作 doxygen 前步骤,它解析示例源并生成 .dox
包含文本和 \code
块的文件。
嗯...我写了上面提到的脚本
我将它张贴在这里,以防对遇到同样问题的人有所帮助:https://gist.github.com/iboB/925542e1ed5afee2b0083ff4fa970462
要点中有一个示例用法