c++ - 如何使用 Doxygen 提供类的示例代码？

Question

我正在尝试记录嵌入在命名空间中的类，并且我想给出示例用法。我已经编写并包含了示例，它们显示在示例选项卡中。然而，它们并没有在类本身中被引用。例如，来自 this page 上的代码，他们的Doxygen命令写为:

/** \example example_test.cpp
 * This is an example of how to use the Test class.
 * More details about this example.
 */

Doxygen 似乎解析了命令和文件并识别出 Test 类被引用。这似乎并没有发生在我身上。这个功能没有很好的记录，而且几乎不可能通过谷歌搜索到。

这是我的代码的总体布局:

namespace exampleSpace
{
  ///Doxygen documentation

  class exampleClass {};

  ///@example example1.cpp
  ///  example1 description
  ///@example example2.cpp
  ///  example2 description
}

示例描述对类进行了命名，官方文档中也是如此。然而，Doxygen 似乎认出了他们的而不是我的。

我的示例代码已完成并且可以正确编译/运行。

那么放置这些命令的正确位置在哪里，以便 Doxygen 知道它们是这个特定类的示例？

编辑:看起来 Doxygen 实际上正在解析源代码，因为它成功链接到代码中的类和任何成员函数。但是，类页面本身并不链接到这些文件。

Answer 1

我为此使用了 \snippet 。您引用另一个文件，在该文件中您可以用 [mytag] 区域包围代码块。然后在使用 \snippet 的地方显示这些内容。

另请参阅https://stackoverflow.com/a/35759133/356726和 https://stackoverflow.com/a/16034375/356726