doxygen 相关问题

Doxygen是一个多语言文档生成应用程序,适用于C ++,C,Java,Objective-C,Python,IDL,Fortran,VHDL,PHP和C#,支持各种输出格式,包括RTF,HTML,XML和PDF。

如何使用 Doxygen Graphviz 创建不使用继承的单个类的类图?

我评估了 Doxygen。我发现一个类从另一个类继承属性,该类图是由 Doxygen 生成的。 但对于不使用继承的单个类,Dox...

回答 1 投票 0

多行plantuml命令

在c风格代码注释中使用plantuml时 /// 然后 clang 在注释中添加一个 \ 换行符。 /// @startuml /// m_alengthyline.xxxxxxxxxxxxxx .[#green].> \ /// another.longy...

回答 1 投票 0

如何使用 Doxygen 记录依赖于预处理器定义的 typedef?

是否可以记录一个 typedef,根据预处理器定义具有不同类型,并使用 Doxygen 在 html 输出中显示两种替代方案? 我想要记录的代码...

回答 2 投票 0

Doxygen:“A”类在单独的 .cpp 文件中定义的成员函数在“B”类调用函数的调用图中看不到

Doxygen 问题: 我有一个非常大的“A”级。 “A”类成员函数定义在几个文件中,A.cpp、A1.cpp 等。 标头附录 A1.h 等 #included 在 A.h 中。 班级...

回答 1 投票 0

无法使用 Doxygen 从 markdown 文件引用源代码成员

使用 Doxygen,我无法在 Markdown 文件中获取代码引用。我尝试了各种组合都无济于事: ef 我的函数 我的函数() 我的类::我的函数 它们都会导致

回答 1 投票 0

使用 autotools 生成(并安装)doxygen 文档

我正在编写一个库(使用libtools),其中所有API文档都是使用doxygen完成的。 我想知道是否有一个简单的方法来集成生成的doxygen文档的安装...

回答 2 投票 0

Doxygen 错误地将用 markdown 编写的主页部分包含在第一个模块部分中

给定以下两个文件,以及一个 GENERATE_TREEVIEW = YES 的 doxygen 配置文件 简介.txt /** \主页简介。 不能插入模块中 ### 第一部分 这第一...

回答 1 投票 0

将“班级列表”视图配置为默认使用级别 2?

我正在尝试将班级列表视图默认为详细级别 2。详细级别选择位于页面的右上角,默认为级别 1。细节水平控制...

回答 2 投票 0

如何配置 doxygen 模块页面的默认详细级别?

我正在使用 doxygen 生成文档 html 网站。通过使用@defgroup命令,我可以生成模块页面,它们就像手动创建的索引一样。 我的“

回答 1 投票 0

如何让 doxygen 创建跨多个项目的完整继承图?

当使用 doxygen 生成 C++ 继承图时,我注意到这些图可能不完整。 如果使用标记文件记录多个项目以允许交叉引用,doxygen 将

回答 1 投票 0

使用 Doxygen 创建特定函数的调用图

当我将 EXTRACT_ALL、EXTRACT_PRIVATE 和 EXTRACT_STATIC 全部设置为 YES 时,我可以为项目中的几乎所有实体创建调用图。但是如何为特定函数创建调用图...

回答 1 投票 0

gitlab CI/CD /usr/bin/sh: /usr/bin/sh: 无法执行二进制文件错误:作业失败:退出代码 126

我有一个工作管道。我通过安装 STM32CUBEIDE 并将其作为新映像提交来修改容器。相同的 .yaml 文件,只是图像不同。 图片 gul-doxygen - 管道...

回答 1 投票 0

Doxygen 更改生成文件中的节顺序

自动生成的文档的“宏”部分几乎位于顶部。我的许多文件都有数千个定义。是否可以将其移至各部分的底部? 我读到了有关章节的内容...

回答 1 投票 0

发现 doygen 自己的标签的错误用法

我正在使用 doxygen 并在 doxyfile 中定义了我的标签。 现在我想解析标签的正确用法,例如mytag 后没有空白。 @mytag{正确} @mytag {不正确} 和其他...

回答 0 投票 0

我可以将我的 GitHub Pages index.html 放在存储库的子文件夹中吗?

我正在尝试使用 GitHub 页面来托管 Doxygen 站点。理想情况下,我希望能够将生成的文件和目录推送到 GitHub,而无需对其进行任何调整。 然而,这意味着......

回答 7 投票 0

如何让 Doxygen 在派生方法签名中跳过对基类的提及?

我有以下课程 命名空间细节{ 模板 类基础{ /// @brief 一个 foo 方法 无效的 foo(){} }; } /// @brief 派生类 模板 ...

回答 0 投票 0

doxygen 外部命令/排除除

是否有可能从输出中排除所有记录的函数、类、页面,除了那些特别标记的? 我有一个有据可查的(大)项目。大多数功能

回答 0 投票 0

在 powershell 脚本中嵌入 doxygen 文档

我想制作一个带有漂亮文档的 PowerShell 模块或脚本。 PowerShell 文档被写入注释块,如下所示: <# .SYNOPSIS My module does a nice job. .

回答 0 投票 0

没有 HTML 替换为用于 XML 输出的 Doxygen erbatim 块

问题 我的一个标题中有以下片段: /** * @brief 简单的功能。 * * @逐字 * 不希望将以下内容呈现为 <: > 或 \> ! * @endver...

回答 0 投票 0

Doxygen:在不更改 CSS 的情况下显示数字枚举值?

我需要一种方法让 doxygen 在 doxygen 输出中显示枚举成员的真实值。 例如我有: ///我的枚举 typedef 枚举 My_Enum { MY_ENUM_0,/// 我需要一种方法让 doxygen 在 doxygen 输出中显示枚举成员的真实值。 例如我有: ///MyEnum typedef enum My_Enum { MY_ENUM_0,///<MY_ENUM_0 MY_ENUM_1,///<MY_ENUM_1 MY_ENUM_2 ///<MY_ENUM_2 } My_Enum; 输出为: MyEnum. Enumerator: MY_ENUM_0 MY_ENUM_0. MY_ENUM_1 MY_ENUM_1. MY_ENUM_2 MY_ENUM_2. 我想要的是: Enumerator: MY_ENUM_0 0 MY_ENUM_0. MY_ENUM_1 1 MY_ENUM_1. MY_ENUM_2 2 MY_ENUM_2. 或类似的东西。 我没有办法直接从 doxygen 中执行此操作。 Doxygen 不是 C 编译器。所以它不会派生出编译时常量枚举的值。 doxygen 能做的最接近的事情是有选择地扩展你的宏 因为它有一个 C 预处理器。所以如果你有一些值分配给一个由预处理器扩展派生的常量,doxygen 可以扩展宏并告诉你将分配什么。 基于 TheCodeArtist 的回答,您可以考虑编写在 doxygen 之前运行的脚本,复制您的文件,搜索此模式: enum *** { ***, ///< %VAL%: 并将每次出现的 %VAL% 替换为应有的值,这样您就不必手动跟上数字。 doxygen 运行后,需要替换包含 %VAL% 标记的原始文件。这不是一个特别优雅或强大的解决方案。 使用doxygen,我们可以记录: enum 它的价值观 每个值的描述 以下代码片段描述了上述所有 3 个示例。 /*! \enum My_Enum * Documentation of the enum type. */ typedef enum My_Enum { MY_ENUM_0, /*!< Document the value 0 */ MY_ENUM_1, /*!< Document the value 1 */ } My_Enum; /*! \var My_Enum MY_ENUM_0 * The description of the MY_ENUM_0. Can contain its enumerated name */ /*! \var My_Enum MY_ENUM_1 * The description of the MY_ENUM_1. Can contain its enumerated name*/ 还要注意,由于宏/枚举扩展不会在 doxygen 注释中发生。如果在 doxygen 注释中使用了任何内容,则需要使用 INPUT_FILTER 对其进行扩展。例如: INPUT_FILTER = sed /MY_ENUM_0/0 是以下代码片段所必需的 typedef enum My_Enum { MY_ENUM_0, /*!< MY_ENUM_0 */ ... 另请查看此 answer 以了解有关多种 doxygen 评论风格的详细信息: ///< <comment> /*!< <comment> */

回答 2 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.