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