Question

我正在使用doxygen version 1.8.8来构建C ++文档。我包括对我的模板化类的详细描述，如下所示：

/** A test class. Detailed description of the test class
 *  Usage:
 *  @code
 *    test a;
 *  @endcode
 */
template<>
class test
{
  //some class
};

，并希望将示例包含到名为testexample.cpp的文件中

如果我只将@example放在详细说明的末尾，则将详细说明应用于示例。

/** A test class. Detailed description of the test class
 *  Usage:
 *  @code
 *    test a;
 *  @endcode
 *  @example testexample.cpp
 *  An example of the test class.
 */
template<>
class test
{
  //some class
};

如何获得有关该类的详细说明以及指向示例文件的链接，该示例详细显示了该类的用法？

在@example的强力示例中，他们将示例引用到成员变量。该示例链接到该成员函数。在这种情况下，这不是我想要实现的，因为我想展示如何在一个完全有效的示例中而不是在用法说明中使用该类。

Answer 1

Doxygen处理示例的方式是，代码示例是与常规文档分开的页面。因此，@example就像@page或@module一样：它占据了整个文档块并将其应用于示例页面。在该示例代码中使用的任何文档化实体，其文档都将添加该示例的至链接。

因此，您需要的是一个独立的文档块，如下所示：

/**
 *  @example testexample testexample.cpp
 *  An example of the test class.
 */

此类不必与test类放在同一文件中。

Answer 2

在收到nicol的回答后，我通过以下方式实现了我所寻找的目标：

EXAMPLE_PATH

我已经这样尝试过，但是因为我没有在Doxyfile中设置@example，所以找不到该示例，因此EXAMPLE_PATH标记变得无用。指定<template> <div> <div v-for="item in getItems" > <span :is="item | render" ></span> </div> </div> </template> <script> import { mapGetters } from 'vuex'; import Vue from 'vue'; export default({ props: ['propobject'], ...mapGetters('modA', ['getItems']), }, }); Vue.filter('render', item => Vue.compile(item)); </script>后，一切都会按预期进行。

c ++ Doxygen \示例和说明

2 个答案: