2

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

所以我有一个 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 默认创建的位置

  • 我的源代码在用户/桌面/

  • 输出文件夹位于用户/桌面/文档中

4

2 回答 2

1

要记录全局函数，您还必须包含文件名。例如

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

于 2014-09-04T11:50:32.813 回答
1

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

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

于 2014-09-04T11:57:41.540 回答