如何显示C ++风格在doxygen中包含语法

时间:2019-04-16 08:43:15

标签: c++ doxygen

我在文件中添加了doxygen注释。当我生成HTML文件(使用doxygen应用程序)时,我可以看到

MyClass类参考

#include <myclass.hpp>

我想显示为

MyClass类参考

#include <MyClass>

我尝试了各种选择,但是没有运气。我尝试使用\ file MyClass,但仍显示相同的行(如上所述)。

这里是氧气的评论

/**
 * \class MyClass
 *
 * \ingroup demo
 *
 * \brief Provide an example
 *
 * This class is meant as an example.  It is not useful by itself
 * rather its usefulness is only a function of how much it helps
 * the reader.  It is in a sense defined by the person who reads it
 * and otherwise does not exist in any real form. 
 *
 * \file MyClass
 *
 * Contact: abc@abc.com
 *
 * Created on: Wed Apr 13 18:39:37 2005
 *
 */

1 个答案:

答案 0 :(得分:3)

来自Doxygen FAQ

  

您还可以按照以下步骤记录您的课程

/*! \class MyClassName include.h path/include.h
 *
 *  Docs for MyClassName
 */
     

要放出氧气

     

#include <path/include.h>

     在类MyClassName的文档中的

而不考虑名称   实际头文件的内容,其中MyClassName的定义是   包含。

所以我会尝试:

/**
* \class MyClass myclass.hpp MyClass
...
*/