Question

我确信这是愚蠢的我已经完成但我无法看到它是什么：

所以我有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中运行时，没有做出额外的评论。

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

作为一个完整的新手试图改造我的项目，毫无疑问我省略了做一些重要的事情，但我读过的所有文档/教程都没有提出除了我以外的任何建议。我已经说过需要这样做，所以我求助于知识渊博的SO社区寻求帮助

更新：

在回应Arne Mertz的评论时，还有一些细节：

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

Answer 1

我怀疑是愚蠢，为了安全起见我制作了我的项目副本，所以我编辑的版本不是doxygen所解释的版本

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

Answer 2

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关键字后面的名称应与文件名完全相同。

Doxygen似乎没有识别评论（Doxywizard）

2 个答案: