如何在 doxygen 中显示 C++ 样式包含语法
How to show C++ style include syntax in doxygen
我正在将 doxygen 注释放入我的文件中。当我生成 HTML 个文件(使用 doxygen 应用程序)时,我可以看到
我的Class Class参考
#include <myclass.hpp>
我想像
一样显示
我的Class Class参考
#include <MyClass>
我尝试了各种选择,但没有成功。我尝试了 \file MyClass,但仍然显示相同的(上述)行。
这里是 doxygen 评论
/**
* \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
*
*/
来自Doxygen FAQ:
You can also document your class as follows
/*! \class MyClassName include.h path/include.h
*
* Docs for MyClassName
*/
To make doxygen put
#include <path/include.h>
in the documentation of the class MyClassName regardless of the name
of the actual header file in which the definition of MyClassName is
contained.
所以我会尝试:
/**
* \class MyClass myclass.hpp MyClass
...
*/
我正在将 doxygen 注释放入我的文件中。当我生成 HTML 个文件(使用 doxygen 应用程序)时,我可以看到
我的Class Class参考
#include <myclass.hpp>
我想像
一样显示我的Class Class参考
#include <MyClass>
我尝试了各种选择,但没有成功。我尝试了 \file MyClass,但仍然显示相同的(上述)行。
这里是 doxygen 评论
/**
* \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
*
*/
来自Doxygen FAQ:
You can also document your class as follows
/*! \class MyClassName include.h path/include.h * * Docs for MyClassName */
To make doxygen put
#include <path/include.h>
in the documentation of the class MyClassName regardless of the name of the actual header file in which the definition of MyClassName is contained.
所以我会尝试:
/**
* \class MyClass myclass.hpp MyClass
...
*/