2

我正在尝试记录嵌入在命名空间中的类，并且我想给出示例用法。我已经编写并包含了示例，它们显示在示例选项卡中。但是，它们没有在类本身中引用。例如，从本页的代码中，他们的 Doxygen 命令写成：

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

似乎 Doxygen 解析了命令和文件并识别出Test该类被引用。这对我来说似乎没有发生。此功能没有很好的文档记录，Google 几乎不可能。

这是我的代码的一般布局：

namespace exampleSpace
{
  ///Doxygen documentation

  class exampleClass {};

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

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

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

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

编辑：似乎 Doxygen 实际上正在解析源代码，因为它成功链接到代码中的类和任何成员函数。但是，课程页面本身并没有链接到文件。

4

2 回答 2

2

我已经习惯\snippet了。您引用另一个文件，在该文件中，您可以用[mytag]区域包围代码块。然后显示在哪里\snippet使用。

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

于 2016-03-04T18:10:02.517 回答
1

在这一点上只是一个猜测，但我敢打赌，由于命名空间，Doxygen 不会匹配。

使链接发生的一些想法：

  • 明确限定示例中所有名称的命名空间
  • 将代码放在命名空间中的示例中
于 2012-07-30T19:43:08.847 回答