在下面的最小示例中,我在命名空间中有一个模板 class。 每个成员的描述都引用了另一个成员。/// @brief My namespace namespace template_test { template <int param_v> class TemplateClass { ...
在下面的最小示例中,我在命名空间中有一个模板 class。 每个成员的描述都引用了另一个成员。/// @brief My namespace namespace template_test { template <int param_v> class TemplateClass { ...
在我使用 doxygen 1.9.1 记录的 C 项目中,我有几个记录的宏,例如/** * @brief Does a thing. */ #define DO_THING() someFunc(1, 2, 3) 当我生成文档时,列出了DO_THING但它显示了扩展(即someFunc(1, ...
我在 C++ 中创建了一个简单的库,并且在 Doxygen 中以相当好的纪律记录了 API。 在 package 中有几个示例程序可以使用该库。在同一个 Doxygen 进程中记录这些(作为命令行程序)是否有技巧? ...
我有一个 C++ 库,其中包含几个用 Doxygen 样式注释记录的源文件。 在库中,有三个 class 模板( Array 、 Vector 、 Span )都继承了相同的基础 class 模板( VctrBase )。 我在 Doxyfile 中将INLINE_INHERITED_MEMB设置为 ...
我注意到,当使用 Doxygen 记录 a.c 文件时,给定文件中包含的列表也包含在 output 中,例如: https://agnix.sourceforge.net/documentation/api/bridge_8c.html 现在,我通常做的是在给定的“include block” ...
我正在处理一个 C++ 项目,该项目公开了许多构成界面重要部分的全局constexpr变量。 我已经像这样记录了所有这些 (有关更多代码上下文,请参见此处)。 现在,当运行 doxygen 时,会呈现在同一源文件中声明的 class 的文档,但没有该变量的文档。 我已经尝试了一些配置选项,但到目前 ...
我正在使用doxygen记录一个 C++ 项目。 在这个项目中,有一些宏被正确记录在代码中。 在我的 doxyfile 中,我指定我不想要这样的文件选项卡: 问题是这样做时,我无法看到宏文档,因为它似乎只能通过“文件”选项卡访问: 我想要的是能够在不提供文件文档的情况下查阅宏文档。 有什么办法可以 ...
Doxygen 有一个@example标签,用于在生成的文档末尾的补充部分中包含示例。 这似乎工作正常,但示例是按文件名排序的,最好在不修改文件名的情况下控制它们的顺序。 如果您有 50 个示例并且在中间插入一个新示例将是一场悲剧,则尤其如此。 有一些选择可以做到这一点吗? ...
我正在使用 doxygen 1.8.18,并希望在 html 生成的嵌套结构中的变量文档中有一个链接。 我正在尝试为以下场景建立链接: 为变量和定义它的结构创建链接是有效的: 但是我的目标是为嵌套结构中的变量创建一个链接: 这是受支持的还是我做错了? 定义结构的所有文件都包含在 doxyfile 配 ...
我在名为impstrcts.h的文件中有以下命名空间和一些代码 有没有办法让一般的 doxygen 注释单独出现,或者可能与名称空间中的每个结构一起出现? 因为现在, some doxygen for the collection of label_str, Label_map, big_map只出 ...
我正在使用通过相对路径引用图像的 .md 文件生成 sphinx 文档: .[](../_static/figures/image.png) 我使用 MyST 将 .md 文件解析为 html,但它删除了../'制作所有路径: _static/figures/image.png 。 相对路径在文档 ...
这里有两个 styles 对实体的评论(例如,在类似 C/C++ 的语言中)。 款式一: 样式 2: 我知道,通常,在编写 doxygen 注释时,它通常出现在记录的实体之前,例如: 情况总是如此,还是我可以将它放在实体之后,就像上面的第二种评论风格一样? ...
我正在尝试使用 Doxygen 记录我的代码。 我希望生成的 HTML 根据 SW 架构组织树视图,以便简单快速地理解项目。 我有一个这样组织的项目: 我遇到的问题是 doxygen 自动生成的树视图是扁平的。 所有元素都具有相同的级别。 当前结果是: 我的目标是拥有这样的东西: 我对分组和部 ...
我有一个具有这种结构的项目: 但是,所有这些文件都显示在根目录中,没有任何层次结构。 我没有遵循上面的结构,而是得到了这个结构: 我怎样才能在 doxygen 的文档中得到这个结构? ...
我想将一个结构记录为一个结构的成员,在一种风格中,将有一个指向预先计算的结构的可点击链接,与calibrator_calibration_t上的结构相同,单击后它将向我显示precalculated的所有成员。 生成 HTML: 我尝试了许多不同的方法,但没有一种方法能满足我的需要。 任何提示? ...
I have a project with bash, python, and C files where I would like to simply print the contents of the bash file in the doxygen documentation. 我正在使用 ...
我们使用 Doxygen 为我们的软件库生成 API 和相关文档。 该库是用 C++ 编写的,公开了一个 C 接口,并包括其他语言的包装器,例如 C# 和 ZA37241719.324265B69。 许多包装语言使用与 C API 相同的结构/类名称。 当 Doxygen 找到其中一个时,它总是链接 ...
在 class 内的 function 的文档字符串中添加空行会破坏 Doxygen 特殊命令的解析。 这有效 但这并不 当文档字符串中的空行不在 class 函数中时,它们是可以的,因此缺乏一致性。 出于美学原因,我喜欢空白行并打破描述中的输入。 如何使它与空行一起使用? ...
是否可以在 LaTeX output 中嵌入使用UML_LOOK = YES生成的 UML 图? 编辑: 我正在使用 Doxygen 1.9.1。 doxygen -x Doxyfile的 output 看起来像这样: 对于像这样的最小源文件 HTML output 包含这种图: 但 LaT ...
我一直在努力使用 Doxygen(和 DoxyWizard)为 VC++ 项目生成完整的文档。 这是目录结构: 我关心的唯一类位于Project1/Project1目录中。 Ah 、 Bh和C.h包含抽象基类。 派生类位于各自的 A、B 和 C 目录中。 因此,例如,文件Project1/Proj ...