小编Bea*_*rer的帖子

C++ Doxygen \示例和描述

我正在使用它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
};
Run Code Online (Sandbox Code Playgroud)

并希望在名为的文件中包含一个示例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
};
Run Code Online (Sandbox Code Playgroud)

如何获得该类的详细描述以及示例文件的链接,以详细方式显示该类的用法?

在 doxygen …

c++ doxygen

6
推荐指数
2
解决办法
6716
查看次数

标签 统计

c++ ×1

doxygen ×1