如何将示例与Doxygen集成？ [英] How to integrate examples with Doxygen?

问题描述

我记录了我的所有课程，现在我想集成一个如何使用这些类的例子。我怎么做？

解决方案

您可以将示例源代码放在doxygen配置中定义的特殊路径下， EXAMPLE_PATH ，然后插入示例与 @example 标签。

然后，Doxygen将生成一个额外的包含示例的源的页面。它还将从包含示例标签的类文档中设置一个链接。

或者，如果要使用小代码片段，可以使用 @code ... @endcode

这里的文档在这里：
Doxygen文档？

I documented all of my classes and now I want to integrate an example of how to use these classes. How do I do that?

解决方案

You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH, and then insert examples with the @example tag.

Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.

Alternatively if you want to use small code snippets you can insert them with @code ... @endcode

The documentation for this is here: Doxygen documentation?

这篇关于如何将示例与Doxygen集成？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！