首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >doesn似乎无法识别评论(Doxywizard)

doesn似乎无法识别评论(Doxywizard)
EN

Stack Overflow用户
提问于 2014-09-04 09:44:03
回答 2查看 1.6K关注 0票数 2

我肯定这是我做过的傻事,但我看不出是什么:

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

另外,为了在函数之上获得一些输出,我按照doxygen规范所要求的样式添加了一个注释:

代码语言:javascript
复制
//! 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();
}

但是,当我在made向导中单击run时,没有额外的注释。

如果我将提取模式设置为文档实体,那么只有main.cpp甚至不会出现。如果我将其设置为所有实体,main.cpp就会出现在文件下面,并且函数在文件中,但是文件中没有任何细节。

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

更新:

针对阿恩·默茨的评论,以下是更多细节:

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

回答 2

Stack Overflow用户

发布于 2014-09-04 11:50:32

要记录全局函数,还必须包含文件名。等。

代码语言:javascript
复制
/*!
 * \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关键字后面的名称应该与文件的名称完全相同。

票数 1
EN

Stack Overflow用户

发布于 2014-09-04 11:57:41

为了安全起见,我做了一个项目的副本,所以我正在编辑的版本不是由doxygen解释的版本。

我向那些浪费时间试图帮助这件事的人道歉,但我非常感谢你这样做的努力:)

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/25662208

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档