代码之家 › 专栏 › 技术社区 › Mohan

doxygen:在.dox文件中记录类

doxygen

Mohan · 技术社区 · 6 年前

可以使用\class命令将类的文档放入.dox文件中--请参见 http://www.doxygen.nl/manual/commands.html#cmdclass . (对于我们这些发现javadocs风格文档使头文件几乎不可读的人。)

如何将类方法的文档也移到.dox文件中?

举个例子,如果我有一个数据类型.h

struct Coordinates {
    const double lat;
    const double lng;

    Coordinates(double lat, double lng);
};

然后我创建datatypes.dox

/** \class Coordinates
 * \brief Represents (latitude, longitude) coordinates encoded according to the World Geodetic System (WGS84).
 */

/* \var const double Coordinates::lat
 * \brief the latitude
 */

然后在索引中提取坐标,但坐标::lat不是。正确的方法是什么?

1 回复 | 直到 6 年前

albert 6 年前

查看datatypes.dox的代码,我们可以看到:

/* \var const double Coordinates::lat
 * \brief the latitude
 */

这不是一个可以理解的doxygen注释,而是一个常规的注释。注释应该是(注意第二个 * 在第一行中):

/** \var const double Coordinates::lat
 * \brief the latitude
 */

或者,您可以将这两个文档部分连接到:

/** \class Coordinates
 * \brief Represents (latitude, longitude) coordinates encoded according to the World Geodetic System (WGS84).
 *
 * \var const double Coordinates::lat
 * \brief the latitude
 */

推荐文章

Dale Barnard · 如何阻止Doxygen为C#项目生成包索引?

7 年前