doxygen相关内容

如何记录函数的全局依赖关系?

我从第三方供应商那里获得了一些C代码(用于嵌入式平台),该代码使用了全局变量(用于速度和空间优化).我正在记录代码,转换为 Doxygen 格式. 如何在函数文档中为函数需要的有关全局变量和函数的注释? Doxygen 具有用于注释参数和返回值的特殊命令,如下所述: ..
发布时间:2021-05-02 20:02:51 其他开发

氧分组

我对氧气中的页面和组有疑问.我有一个项目,在这里我将类等与@defgroup和@ingroup cmds分组.到目前为止,一切正常. 现在,我想为带有降价页面的项目添加特殊文档.这些页面应显示在专用模块(组)中.我尝试使用@page和@subpage cmds创建页面.效果很好,但是页面在菜单中显示为纯白. 因此,我尝试使用@ingroup将它们添加到组中.但这不起作用,正如我猜到的那 ..
发布时间:2021-05-02 20:02:28 其他开发

在Doxygen中记录条件专用代码

考虑 //EXTERNAL_MACRO是由构建系统定义为某个值的外部宏#if EXTERNAL_MACRO == 1#定义EXCLUSIVE_MACRO_ONE#elif EXTERNAL_MACRO == 2#定义EXCLUSIVE_MACRO_TWO#别的#定义EXCLUSIVE_MACRO_OTHER#万一 在构建时,仅定义了EXCLUSIVE_MACRO _...宏之一. 一个 ..
发布时间:2021-04-24 21:03:14 其他开发

如何为Doxygen样式的文件头配置CLion?

每次我在CLion上创建.cpp/.h文件时,都会得到一个像这样的自动文件头: ////由我在18年11月11日创建.// 这很整洁,但我希望这样的东西符合Doxygen的要求: /*!* @作者我* @日期18/12/3.*/ 得益于出色的CLion集成,我可以轻松地对此进行编辑并添加更多Doxygen字段. 这似乎是一件微不足道的任务,但我仍然没有设法实现它.有人可以帮我吗? ..
发布时间:2021-04-22 19:22:21 C/C++开发

Doxygen是否支持C ++ 11模板别名(' using'语法)?

我正在使用doxygen 1.7.1生成一些C ++ 11代码的文档,并且似乎正在忽略我的模板别名. 为清楚起见,这是模板别名的示例: template使用ResultOf = std :: result_of :: type; 它也无法使用语法更清晰的新代码来拾取更多的传统typedef: using PredicateOne = std :: fu ..
发布时间:2021-04-20 18:45:14 C/C++开发

调用doxygen时在命令行中配置一些变量

我想使用预定义的foo.doxyfile生成doxygen文档.我想修改例如PROJECT_NUMBER,并生成带有bat文件的文档.这是蝙蝠的内容: @echo关闭setLocal enabledelayedexpansioncls回声运行氧气rem设置很多变量设置BASE_DIR =%〜dp0设置"PathToDoxygen = C:\ Program Files \ Doxygen \ ..
发布时间:2021-04-15 18:48:33 其他开发

氧点.通过注释在类之间绘制链接

Doxygen可以使用graphiz生成类图. 例如: class A {...}; class B extends A {...}; 从这段代码中,我可以生成一张图片,其中doxygen可以证明一个类是另一个的父类. 但是,有没有一种方法可以通过在类之间进行手动引用的代码来生成图片呢? 例如,当我描述数据库方案并使用合同类时( http://developer.and ..
发布时间:2020-11-20 19:27:30 Java开发

使用cpp文件中的现有代码范围作为文档示例

我可以在doxygen文档中使用现有代码范围(表示 cpp 文件中的几行代码)作为示例吗? / *! *简要介绍我的Foo课程 * \详细了解foo * \示例? Foo像这里一样使用,cpp的一些LOC遵循(我该怎么做?) * / 类Foo 我想显示3-10行现有代码,说明我如何使用 Foo 。这些3-10行应该来自 cpp 文件。 我知道我必须 ..
发布时间:2020-10-26 02:08:49 C/C++开发

Doxygen失去了非静态Java通用方法

我遇到了一个问题,即Doxygen在文档中不包括非静态Java通用方法。找不到使用以下语法的方法: public ReturnType methodName(ArgType1 arg1,ArgType2 arg2)引发异常{} 但是,以下方法声明都可以找到并包含在文档中: public static ReturnType ..
发布时间:2020-10-26 02:07:45 Java开发

由于名称空间,Doxygen无法注意到重复项

当我对要记录的某些第三方库运行Doxygen时,它无法将某些条目识别为重复项。看起来好像某些代码使用了命名空间,而某些代码(已经在该命名空间中了?)遗漏了命名空间,这导致Doxygen感到困惑。 例如,当我查看类索引页面或类成员页面时,它生成的页面可能包括所有这些页面,就好像它们是4个不同的调用一样: foo :: bar(aaa :: bbb) foo :: bar(bbb) b ..
发布时间:2020-10-26 02:07:41 其他开发

Doxygen无法正确识别属性

我在Objective-C上有一个如下定义: @property(非原子,保留)BOOL myProperty NS_AVAILABLE_IOS (3_2); 使用Doxygen解析此头文件时,其类型为“ BOOL myprop”,名称为“ NS_AVAILABLE_IOS”和参数为“(3_2)”。 有什么方法可以使Doxygen正确地识别出这一点而无需添加注释 ..
发布时间:2020-10-26 02:07:38 移动开发

删除doxygen的\copydoc点?

我对doxygen的 \copydoc 有疑问。例如 file1.h / *! * \file * FileOne * / file2.h / *! * \file *这类似于\copydoc file1.h文件。 * / 文档始终显示: 这类似于。 FileOne。文件。 我不希望添加此 ..
发布时间:2020-10-26 02:07:34 C/C++开发

Doxygen:为什么忽略了我的上一个Objective-C接口或协议?

我有一个头文件,Doxygen正确地将其列为项目的文件之一,它将显示源代码。 Doxygen输出显示文件正在处理中。 但是,文件中声明的协议没有记录在类列表中。 I尝试在未显示的协议前立即声明另一个名为Foo的协议。新协议已正确处理。我添加了另一个名为Bar的酒吧。它也可以正确处理,但原始协议仍然没有。我删除了原始协议,现在不再处理Bar。 基本上,我声明的所有协议(或接口 ..
发布时间:2020-10-26 02:07:30 移动开发

使用Doxygen,如何生成一个页面,该页面包含指向我项目中所有.dox文件的子页面链接?

我有一个\mainpage,其中仅包含主页链接。 但是,我想在最终输出文档中有一个页面,其中包含指向.dox文件的所有页面链接。 我知道这可以可以使用外部脚本来解析.dox文件并聚合所有页面变量名称。 解决方案 您可以使用xrefitem +别名来完成可能会完成哪些任务的配置字段? 如果您不熟悉xrefitem以及可以使用它创建的列表,那么这里有一个参考: http://ww ..
发布时间:2020-10-26 02:07:27 其他开发

我可以在CHM文件中使用doxygen创建交互式SVG图像文件吗?

我想在由doxygen创建的文档中使用交互式svg图像文件。 在浏览器中打开html帮助文件没有显示错误。 当我在Windows chm帮助文件查看器中打开页面时,出现错误: 此页上的脚本发生错误。 行:9 字符:1 错误:“ init”未定义。 代码:0 URL:mk:@MSITStore some_long_address.svg 什么如何使用交互式 ..
发布时间:2020-10-26 02:07:20 其他开发

相对于Doxygen的QHG_LOCATION路径是什么?

当将 QHG_LOCATION 设置为绝对路径时,可以在html和qch中创建有效的doxygen文档。如果我将qhelpgenerator及其DLL放入当前目录 ./ 并设置 QHG_LOCATION = qhelpgenerator ,它也可以工作。但是我不知道如何将qhelpgenerator放入子目录 qt / bin / qhelpgenerator 并让doxygen找到它。总是说 ..
发布时间:2020-10-26 02:07:16 其他开发