cost 103 ms
在 Doxygen 中记录命令 - Documenting command in Doxygen

我在 C++ 中创建了一个简单的库,并且在 Doxygen 中以相当好的纪律记录了 API。 在 package 中有几个示例程序可以使用该库。在同一个 Doxygen 进程中记录这些(作为命令行程序)是否有技巧? ...

2023-01-08 17:30:44   1   36    c++ / doxygen  
使全局 constexpr 变量出现在 doxygen 文档中 - Make global constexpr variable appear in doxygen documentation

我正在处理一个 C++ 项目,该项目公开了许多构成界面重要部分的全局constexpr变量。 我已经像这样记录了所有这些 (有关更多代码上下文,请参见此处)。 现在,当运行 doxygen 时,会呈现在同一源文件中声明的 class 的文档,但没有该变量的文档。 我已经尝试了一些配置选项,但到目前 ...

2023-01-02 17:03:36   1   30    c++ / doxygen  
隐藏文件时记录 C++ 宏 - Document C++ macros when hiding files

我正在使用doxygen记录一个 C++ 项目。 在这个项目中,有一些宏被正确记录在代码中。 在我的 doxyfile 中,我指定我不想要这样的文件选项卡: 问题是这样做时,我无法看到宏文档,因为它似乎只能通过“文件”选项卡访问: 我想要的是能够在不提供文件文档的情况下查阅宏文档。 有什么办法可以 ...

如何指定 doxygen @examples 的顺序 - How to specify ordering for doxygen @examples

Doxygen 有一个@example标签,用于在生成的文档末尾的补充部分中包含示例。 这似乎工作正常,但示例是按文件名排序的,最好在不修改文件名的情况下控制它们的顺序。 如果您有 50 个示例并且在中间插入一个新示例将是一场悲剧,则尤其如此。 有一些选择可以做到这一点吗? ...

Doxygen 1.8.18 - 嵌套结构链接生成 - Doxygen 1.8.18 - Nested structure link generation

我正在使用 doxygen 1.8.18,并希望在 html 生成的嵌套结构中的变量文档中有一个链接。 我正在尝试为以下场景建立链接: 为变量和定义它的结构创建链接是有效的: 但是我的目标是为嵌套结构中的变量创建一个链接: 这是受支持的还是我做错了? 定义结构的所有文件都包含在 doxyfile 配 ...

2022-12-07 14:06:57   1   34    c / doxygen  
如何使用 doxygen 确保命名空间中的每个结构出现相同的注释 - How to ensure that the same comment appears for each struct in a namespace using doxygen

我在名为impstrcts.h的文件中有以下命名空间和一些代码 有没有办法让一般的 doxygen 注释单独出现,或者可能与名称空间中的每个结构一起出现? 因为现在, some doxygen for the collection of label_str, Label_map, big_map只出 ...

2022-12-05 16:10:15   1   26    c++ / doxygen  
使用 doxygen,什么时候应该将注释放在实体之前,什么时候放在实体之后? - With doxygen, when should the comments be placed before the entity, and when after?

这里有两个 styles 对实体的评论(例如,在类似 C/C++ 的语言中)。 款式一: 样式 2: 我知道,通常,在编写 doxygen 注释时,它通常出现在记录的实体之前,例如: 情况总是如此,还是我可以将它放在实体之后,就像上面的第二种评论风格一样? ...

我如何根据 doxygen 的体系结构分段组织文件? - How can I organize files in sections according to an architecture with doxygen?

我正在尝试使用 Doxygen 记录我的代码。 我希望生成的 HTML 根据 SW 架构组织树视图,以便简单快速地理解项目。 我有一个这样组织的项目: 我遇到的问题是 doxygen 自动生成的树视图是扁平的。 所有元素都具有相同的级别。 当前结果是: 我的目标是拥有这样的东西: 我对分组和部 ...

Doxygen:将结构记录为结构的成员 - Doxygen: Documenting struct as a member of a struct

我想将一个结构记录为一个结构的成员,在一种风格中,将有一个指向预先计算的结构的可点击链接,与calibrator_calibration_t上的结构相同,单击后它将向我显示precalculated的所有成员。 生成 HTML: 我尝试了许多不同的方法,但没有一种方法能满足我的需要。 任何提示? ...

2022-09-29 14:24:24   1   53    c / doxygen  
多语言 API 的 Doxygen 链接 - Doxygen links for a multi-language API

我们使用 Doxygen 为我们的软件库生成 API 和相关文档。 该库是用 C++ 编写的,公开了一个 C 接口,并包括其他语言的包装器,例如 C# 和 ZA37241719.324265B69。 许多包装语言使用与 C API 相同的结构/类名称。 当 Doxygen 找到其中一个时,它总是链接 ...

2022-09-08 10:27:28   1   22    doxygen  
python function 文档字符串中的空行破坏了 Doxygen 特殊命令 - Blank line in python function docstring breaks Doxygen special commands

在 class 内的 function 的文档字符串中添加空行会破坏 Doxygen 特殊命令的解析。 这有效 但这并不 当文档字符串中的空行不在 class 函数中时,它们是可以的,因此缺乏一致性。 出于美学原因,我喜欢空白行并打破描述中的输入。 如何使它与空行一起使用? ...

即使启用了递归搜索,Doxygen 也不会处理子目录中的类 - Doxygen does not process classes in subdirectories even with recursive search enabled

我一直在努力使用 Doxygen(和 DoxyWizard)为 VC++ 项目生成完整的文档。 这是目录结构: 我关心的唯一类位于Project1/Project1目录中。 Ah 、 Bh和C.h包含抽象基类。 派生类位于各自的 A、B 和 C 目录中。 因此,例如,文件Project1/Proj ...


 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM