Doxygen：在 .dox 文件中记录类

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

然后坐标在索引中被拾取，但 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
 */