Doxygen：在.dox文件中记录类

\class命令可用于将类的文档放入.dox文件中--请参阅。（对于我们这些发现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
 */

---

然后在索引中拾取坐标，但坐标：：lat不是。正确的方法是什么？

查看Datatypes.dox的代码，我们看到：

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

这不是doxygen理解的注释，而是常规注释。注释应该是（注意第一行的第二个

*

）：

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

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

---

请提供您想要的更多信息（例如，一个小示例+输出指示）。看起来有点像您想使用

\copydoc

，但您的问题并不清楚。请同时指定您的强氧版本。@albert请参见上文…D'oh。。。但仍然不对；I get“警告：未声明或定义有文档记录的符号‘const double Coordinates:：lat”。“奇怪，我只得到（如预期）：

../Datatypes。h:6：警告：未记录类坐标的成员坐标（double lat，double lng）（函数）。

../Datatypes。h:4：警告：成员lng（变量）未记录类别坐标。

您使用的是哪个版本的doxygen？您是否尝试过在这个问题中键入的代码，只是剪切并粘贴回去以确保没有其他打字错误（一场白鹅追逐）。可能发现了问题，您是否确定

数据类型.h

与我删除

数据类型时的读法相同。h

我收到了提到的警告。就是这样--我编写了

文件\u PATTERNS=*.h，*.dox

和doxygen不喜欢逗号。非常感谢你！

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