doxygen相关内容

Emacs隐藏/显示支持C ++三斜线Doxygen标记?

我使用Doxygen的三斜杠语法来标记我的C ++代码。有 两个重要的情况出现: 1)块标记注释是行上唯一的元素,可能 或可能不开始冲洗左;例如 class foo ///一个简短的foo描述。详细说明可以 ///继续上许多行。 { ... }; void foo :: bar ///一个简短的bar描述。详细说明可以 ///继续上许多行。 ()co ..
发布时间:2016-10-27 03:26:19 C/C++开发

使用doxygen记录枚举类值

在我的项目中我使用枚举类很多,我使用doxygen作为文档系统。 当在同一个文件中声明多个枚举类并且它们具有相同的成员时,我发现很难生成枚举类的文档。 例如,以下代码不会为最终HTML输出中的枚举类IMAGE_REPORTING生成正确的文档: 命名空间mapper { / * CONNECTION RELATED * / / ** @enum mapper :: SECURE ..
发布时间:2016-10-27 02:30:03 C/C++开发

Doxygen私人功能

有办法让doxygen显示个别私人功能的文件吗?我想doxygen不显示绝大多数私人功能的文档,但显示它的一些选择的私人功能。我的动机是,这些C ++私人函数提供给Python作为扩展,我想要他们的文档显示在Doxygen。然而,我不想让他们公开,因为他们只需要课堂自己; 感谢 解决方案 可以通过将其段标签添加到ENABLED_SECTIONS配置选项来包含\cond和\endcon ..
发布时间:2016-10-26 23:06:36 C/C++开发

Doxygen对声明或定义发表评论?

刚刚开始使用Doxygen在这里记录我的代码,不能决定把它们放在哪里。 看起来好像把它们放在声明文件中,因为它实际上声明了你收到什么,你要返回什么, ,除了那些只在声明文件中的数据成员显然只能记录在那里。 但是我常常在实现文件中找到更方便的注释方法对我来说更容易访问,声明文件不会混乱与几十行的评论,使得更难找到你在开发时寻找。 经验? 解决方案 TL; DR:带声明​​的 ..
发布时间:2016-10-25 17:04:17 C/C++开发

从Doxygen依赖图中排除基本库包含?

我正在用Doxygen记录一个大学的c ++项目,一切都是正确的,但依赖关系图显示如下: 我想图表不显示包括列表,地图或字符串,并且只包括我为项目创建的自定义类,但我不能在网上或文档上找到任何东西。 解决方案 因为你想排除stdlib容器类,你应该添加 std :: 命名空间到您的doxy文件: EXCLUDE_SYMBOLS = std :: * 这将忽略 ..
发布时间:2016-10-25 15:04:43 C/C++开发

c ++:生成函数调用树

我想解析一个项目中的当前c ++文件,并列出其中的所有方法/函数,然后生成函数调用和调用程序树。 F.g.你可以参考doxygen如何生成调用树。 我已经检查了gccxml,但没有列出从另一个函数调用的函数。 请给我建议一些我可以使用的轻量级工具(开源)。 谢谢! 解决方案 静态调用树不一定是运行时调用树。回调和虚函数泥泞的水。所以静态分析只能给你部分的答案。 我 ..
发布时间:2016-10-24 14:15:51 C/C++开发

我应该如何分类与Doxygen的typedef?

我在我的C ++代码中有typedef结构。现在他们被列为 \var typedef。有没有更好的方法来做到这一点?下面是我有的例子: / *! \var typedef etc * \brief etc的类型定义结构 * * \param x type- x的变量声明 * \param y type-变量声明为y * / 我知道我不应该说 param 。 ..
发布时间:2016-10-24 13:29:05 C/C++开发

我应该如何分类与Doxygen的typedef?

我在我的C ++代码中有typedef结构。现在他们被列为 \var typedef。有没有更好的方法来做到这一点?下面是我有的例子: / *! \var typedef etc * \brief etc的类型定义结构 * * \param x type- x的变量声明 * \param y type-变量声明为y * / 我知道我不应该说 param 。 ..
发布时间:2016-10-24 13:09:01 C/C++开发

如何用Doxygen记录宏生成的类?

我使用宏以下列方式生成类: generator.h: class CLASS_NAME:public parent { //使用复杂的 //Boost.Preprocessor生成由CLASS_VARIABLES给出的名称的变量。 } #undef CLASS_NAME #undef CLASS_VARIABLES myclass.h : ..
发布时间:2016-10-24 12:58:01 C/C++开发

如何Doxygen排除一个C ++类?

我想从Doxygen的文档中排除一个类。通常这些类在名称相同的文件中,但是有很多次它们被包括在其他类定义中。 感谢, Kris 解决方案 您可以使用 \cond 代码。在类定义之前,添加: \cond HIDDEN_SYMBOLS 并在类定义之后添加: \endcond 除非在doxy文件中定义 HIDDEN_SYMBOLS 在 ..
发布时间:2016-10-23 22:51:24 C/C++开发

Doxygen:C ++项目中的多个\mainpage块

在两种情况下,我无法确定doxygen的行为是关于 \mainpage 部分: 如果您不指定 \mainpage 部分,是否使用任何其他页面,如果是这样, / li> 如果两个文件都指定了 \mainpage 部分,该怎么办? 解决方案 \mainpage 命令指定用于自定义索引页的内容, 我认为有关多个 \mainpage 命令是它是未定义在经典意义上产生不可预测的结果,取 ..
发布时间:2016-10-23 22:32:25 C/C++开发

我可以在函数头中包含cppcheck抑制吗?

我添加了一个内联注释抑制一个函数的cppcheck未使用的函数警告,但我想包括这个在函数头,以便Doxygen可以记录所有未使用的函数(我正在实现一个API,所以我有许多功能,不会在我的源中使用)。我想不要抑制所有未使用的函数错误,而是基于每个函数。 我想这样做: / ** * API函数说明 * * @param p1函数指针... * @return 0如果成功,否 ..
发布时间:2016-10-23 20:05:35 C/C++开发

我可以在函数头中包含cppcheck抑制吗?

我添加了一个内联注释抑制一个函数的cppcheck未使用的函数警告,但我想包括这个在函数头,以便Doxygen可以记录所有未使用的函数(我正在实现一个API,所以我有许多功能,不会在我的源中使用)。我想不要抑制所有未使用的函数错误,而是基于每个函数。 我想这样做: / ** * API函数说明 * * @param p1函数指针... * @return 0如果成功,否 ..
发布时间:2016-10-23 19:53:47 C/C++开发

是否有一个类似javadoc的C / C ++程序?

一些人建议Doxygen,一些ccdoc,应该更类似于javadoc,但不太支持。 解决方案 我使用 Doxygen 有几个原因: 合作图 继承图 依赖关系图 在提交任何内容之前,所有更改都必须记录在案,我们的常规构建涉及生成文档。 Doxygen的这些非常便利的功能增加了任何项目的总线因素。 ..
发布时间:2016-10-23 19:38:01 C/C++开发

是否有一个类似javadoc的C / C ++程序?

一些人建议Doxygen,一些ccdoc,应该更类似于javadoc,但不太支持。 解决方案 我使用 Doxygen 有几个原因: 合作图 继承图 依赖关系图 在提交任何内容之前,所有更改都必须记录在案,我们的常规构建涉及生成文档。 Doxygen的这些非常便利的功能增加了任何项目的总线因素。 ..
发布时间:2016-10-23 19:31:10 C/C++开发

使用doxygen记录枚举值

给定: 命名空间Foo { class Foo { public: / // Foo枚举,可能的方式foo 枚举类Foo { ///用A Foo b A b, /// Foo它与B B, ///用C C } } } 并且使用 doxygen -g 创建的默认Doxyfile,我得到: 我可以得到枚举值记录吗?我尝试在 ..
发布时间:2016-10-23 13:30:51 C/C++开发

Doxygen将不会在subdir中找到标头

我用Doxygen记录了一个C ++库的头文件。在 Doxyfile 中,我定义了 INPUT = include / 希望Doxygen生成 include / Foo中所有头文件的文档,但它不会:只生成 index.html 。我可以将 INPUT 设置为 include / Foo ,但是文档列出了标题及其基本名称( Reader.hh ),而我想要客户端包括头文件 ..
发布时间:2016-10-22 19:10:08 C/C++开发

如何记录一个函数可能抛出的所有异常?

如果你有一个公共函数,可能会抛出一个异常,使用其他(私人或公共)辅助函数,也可以抛出异常,我认为你应该记录什么异常公共函数可以抛出,这包括抛出的异常。 这样的东西(使用Doxygen): / ** * @throw Exception ... * @throw ExceptionThrownByHelper ... * @throw ExceptionThrownByHe ..
发布时间:2016-10-22 18:06:53 C/C++开发

doxygen是(事实上)标准文档语法规范吗?

我们都有记录我们的代码的好习惯,对吗? 现在,代码中的文档本身有一个语法。它几乎就像一个编程语言本身。问题是: 有多少文档语法? 是否有标准文档语法? 谁在定义此标准?是否有一个官方委员会或机构(如有一个定义C ++标准)? 或者有“doxygen”成为事实上的标准? 听说过doxygen。在我参与的每个开源软件项目中都提到。但是,看着官方的doxygen网站, doxyg ..