Doxygen：在 .dox 文件中记录 class

Question

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

如何将 class 方法的文档也移动到 .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
 */

然后在索引中提取坐标，但 Coordinates::lat 不是。正确的做法是什么？

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 文件中记录 class

Doxygen: documenting class in .dox file

doxygen