Doxygen 似乎无法识别评论（Doxywizard）答案

【问题标题】：Doxygen doesn't appear to recognise comments (Doxywizard)Doxygen 似乎无法识别评论（Doxywizard）
【发布时间】：2014-10-29 00:14:29
【问题描述】：

我确信这是我做过的傻事，但我看不出它是什么：

所以我有一个 c++ 项目，它有一个 main.cpp 文件和一些类。它没有考虑到 doxygen（错误＃1），但我希望纠正我的错误并生成一些文档。所以我安装了 doxygen 并运行了 doxygen GUI，输入了项目名称/概要并指定了源和目标位置。

为了在函数上方获得一些输出，我添加了一个符合 doxygen 规范要求的注释：

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

但是，当我在 doxywizard 中点击 run 时，没有生成额外的 cmets。

如果我将提取模式设置为记录实体，则只有 main.cpp 甚至不会出现。如果我将它设置为所有实体 main.cpp 出现在文件下并且函数在那里但是文件中没有任何细节。

作为一个尝试改造我的项目的新手，毫无疑问，我忽略了做一些重要的事情，但我读过的所有文档/教程除了我所说的需要做的事情之外，没有任何建议，所以我向知识渊博的 SO 社区寻求帮助

更新：

针对 Arne Mertz 的评论，这里有更多细节：

Doxywizard 位于 Program Files/doxygen/bin 中，配置文件位于 doxywizard 默认创建的位置
我的源代码在用户/桌面/
输出文件夹在用户/桌面/文档中

【问题讨论】：

您能否提供您的 doxygen 配置，因为它会影响从源代码文件中提取文档？一个最小但完整的文件来重现您的问题也会派上用场，包括文件所在的路径、运行 doxywizard 的位置、doxygen 配置的位置以及您针对配置文件中的路径进行的配置。
我已经用您要求的信息更新了问题:)
另外，请用@ 符号提及您正在写信给的人的姓名——这样此人就会收到通知。我不会怀疑 Ame Mertz 是否甚至不知道你已经回复了他。一个例外只是您在其下发表评论的帖子的作者。 IE。我没有提到你，但无论如何你都会收到通知的。

标签： c++ doxygen doxygen-wizard

【解决方案1】：

To document a global functions you have also to include a file name. 例如

/*!
 * \file MyFileName.cpp
 * \brief a brief description of a file
 */

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

请注意，\file 关键字后面的名称应与文件名完全相同。

【讨论】：

【解决方案2】：

正如我所怀疑的那样，我很愚蠢，为了安全起见，我复制了我的项目，所以我正在编辑的版本不是 doxygen 解释的版本

我向任何浪费时间试图帮助解决此问题的人道歉，但我非常感谢您这样做的尝试:)

【讨论】：

我遇到了和你一样的问题。当我读到你的回答时，我笑了（“可能是我”）。好吧，这次不是。我确定。现在，1 小时后我想起了这一点，最后三重检查了我正在编辑的文件的路径以及提供给 doxygen 的文件的路径。我的天啊。不敢相信，我真的编辑了错误的文件（在项目的副本中）-.- 所以每个人都在阅读这个答案：仔细检查，如果没有帮助，请查看其他地方，但这很可能是问题所在://