Question

\ class命令可用于将类的文档放入.dox文件中-请参见http://www.doxygen.nl/manual/commands.html#cmdclass。（对于那些发现Javadocs风格文档的人来说，头文件几乎是不可读的。）

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

举个例子，如果我有一个Datatypes.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
 */

然后在索引中选择“坐标”，但没有。什么是正确的方法？

Answer 1

看看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
 */

Doxygen：.dox文件中的记录类

1 个答案: