首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何对函数的未命名参数进行doxygen文档记录?

对函数的未命名参数进行doxygen文档记录可以通过以下步骤实现:

  1. 在函数的注释块中使用@param标签来描述参数。由于未命名参数无法直接在注释中标识,可以使用数字或其他符号来代替参数名。
代码语言:txt
复制
/**
 * @brief 函数描述
 * @param [1] 参数1的描述
 * @param [2] 参数2的描述
 */
void functionName(int, float);
  1. 在函数定义处为未命名参数添加参数名,并在注释中使用相应的参数名。
代码语言:txt
复制
void functionName(int param1, float param2)
{
    // 函数实现
}
  1. 在doxygen配置文件中启用EXTRACT_ALL选项,以确保未命名参数也被记录在文档中。
代码语言:txt
复制
# Doxyfile配置文件中的选项
EXTRACT_ALL = YES

这样,通过以上步骤,未命名参数也会被正确地记录在生成的doxygen文档中。

关于doxygen的更多信息和用法,可以参考腾讯云的产品介绍链接:Doxygen产品介绍

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Firefox 如何发送参数进行调试

在网页或者 API 进行调试时候,尤其是在 OAuth 调试时候,我们希望能够调试发送到 API 数据,这个时候如何进行调试呢?...使用 Firefox 不是十分清楚如何使用 Chrome 进行调试,但是经过一些摸索,我们可以尝试使用 Firefox 进行调试。...如何在 Firefox 上添加上这个参数呢? 选择你已经访问过网址列表,在上图中,返回结果是 401。 单击 Resend 按钮,在弹出对话框中选择 Edit and Resend。...在下一个界面中,你可以对你需要添加参数进行编辑,你可以在这里添加你需要 token 参数。 将上面的参数设置好以后,可以单击选择重新发送。...通过上面的修改和配置,你可以使用 Firefox 不同 Token 状态进行调试,比如说你可以使用过期 Token ,无效 Token 甚至是不发送 Token。

1.3K00
  • NumPy 1.26 中文文档(五十三)

    尽管我们用户公开每个函数和类都有大致完整参考文档,但是一些函数缺乏使用示例。 我们缺少是更广泛范围文档 - 教程,如何做以及解释。报告缺陷是另一种贡献方式。 我们都在讨论。...API 参考文档直接从代码中文档字符串生成,当生成文档时(如何构建文档),它们会为用户展示每个函数和类参考文档,但部分函数缺乏使用示例。 我们缺乏范围更广泛文档 - 教程,操作说明和解释。...最重要是技术错误 - 缺少参数文档字符串,函数/参数/方法错误描述等。其他“结构性”缺陷(例如损坏链接)也会被优先处理。所有这些修复都很容易确认并实施。...doxygengroup 此指令生成适当输出以展示 Doxygen内容。doxygen 组可以通过源注释中特定 doxygen 标记进行声明,参见 doxygen 组织文档。...NaT 特殊日期时间和时间间隔值 np.heaviside 通用函数计算 Heaviside 函数 使用 np.block 函数创建块数组 isin 函数 in1d 进行改进

    10710

    利用Doxygen生成代码文档

    Doxygen是一个代码文档生成工具。它从代码文件中提取注释并可生成多种文档形式。如:网页文档HTML,RTF (MS-Word),PDF等等。同时也可生成函数之间调用和文件依赖关系图表。...如果需要生成chm文件,可将doxygen生成网页文件拷贝至windows环境下,然后用htmlhelp来生成chm文件。 注释和文档效果 头文件中添加如下函数注释。...@brief 表示后面的内容是函数功能描述 @warning 一些警告信息 @param 传入参数说明 @return 函数返回结果说明 @see 方便跳转相关联函数 另外注意,函数注释放在头文件和源文件中效果是等同...项目中markdown文档会生成相应页面 图片 类成员注释 std::string odom_topic; //!...或者直接使用 doxywizard Doxyfile 常用参数配置 打开调用关系图 图片 显示效果如下: 图片 上图显示了该函数调用了哪些函数,然后又被什么函数调用了。

    1.7K40

    doxygen教程_genedoc教程

    Doxygen软件默认生成HTML文件或Latex文件,我们要通过HTML生成CHM文档,需要先安装HTML Help WorkShop软件,并在Doxygen进行关联   见示例效果图。...安装完后进行Doxygen配置时需要关联graphviz和HTML Help WorkShop安装路径。...工作目录是新建一个目录,在配置完成之后可以把配置文件存在这个目录里,每次从这个目录中导入配置文件(.cfg),然后进行说明文档生成。  ...3.先从文件开始注释,然后是所在文件全局函数、结构体、枚举变量、命名空间→命名空间中类→成员函数和成员变量。 4.Doxygen无法为DLL中定义类导出文档。...@author 作者信息 @brief 用于class 或function简易说明 eg:@brief 本函数负责打印错误信息串 @param 主要用于函数说明中,后面接参数名字,然后再接关于该参数说明

    4.4K30

    Windows平台下源码分析工具

    最近这段时间在阅读 RTKLIB源代码,目前是将 pntpos.c文件部分看完了,准备写一份文档记录下这些代码用处、处理过程、理论公式来源、注意事项,自己还没有弄明白地方。...目前想法是把每一个函数都做成一个名片,这个名片内则包含代码功能说明、参数说明、函数调用关系图、整体处理过程、注意事项和自己疑惑这几个部分。...然而我并不想自己去手工绘制函数调用关系图,于是就百度了一下,这才发现关于接口文档、说明文档函数调用关系图这些辅助开发文档早就有人做了专门软件来高效、有组织地来解决这些问题了。...关于函数调用关系图,在 Linux和 Windows平台下也都有不同解决方案,搜索一下就能找到很多与之相关技术文档。...这可以在 Doxygen进行设置,与之有关参数有两个,DOT_GRAPH_MAX_NODES和 MAX_DOT_GRAPH_DEPTH,分别控制图中最大节点数和节点深度,如下图 4所示。

    1.2K30

    Windows平台下源码分析工具

    最近这段时间在阅读 RTKLIB源代码,目前是将 pntpos.c文件部分看完了,准备写一份文档记录下这些代码用处、处理过程、理论公式来源、注意事项,自己还没有弄明白地方。...目前想法是把每一个函数都做成一个名片,这个名片内则包含代码功能说明、参数说明、函数调用关系图、整体处理过程、注意事项和自己疑惑这几个部分。...然而我并不想自己去手工绘制函数调用关系图,于是就百度了一下,这才发现关于接口文档、说明文档函数调用关系图这些辅助开发文档早就有人做了专门软件来高效、有组织地来解决这些问题了。...关于函数调用关系图,在 Linux和 Windows平台下也都有不同解决方案,搜索一下就能找到很多与之相关技术文档。...这可以在 Doxygen进行设置,与之有关参数有两个,DOT_GRAPH_MAX_NODES和 MAX_DOT_GRAPH_DEPTH,分别控制图中最大节点数和节点深度,如下图 4所示。

    1.1K30

    面向 C++ 现代 CMake 教程(四)

    ,但格式化器还是进行了格式化;不允许单行上有短函数。...当然,我们不仅限于这些工具;还有很多:既有自由和开源项目,也有带有广泛支持商业产品。这只是这个主题介绍。确保探索你来说正确东西。在下一章,我们将更详细地查看文档生成。...自从 CMake 3.9 以来,我们可以使用FindDoxygen模块中doxygen_add_docs()函数来设置文档目标。...现在我们可以享受我们生成 HTML 文档现代风格,并自豪地与世界分享。 摘要 在本章中,我们介绍了如何Doxygen,这个文档生成工具,添加到 CMake 项目中,并使其变得优雅。...您可能担心将 Doxygen 添加到没有从开始就使用文档生成较大项目中会很困难。要求开发者在每个函数中添加注释工作量可能让开发者感到不堪重负。

    50800

    clang 源码导读(3): clang driver 参数解析

    前言 本文会对 clang driver 参数解析 流程进行分享 为了控制 clang 运行,clang 必须支持不同参数各种行为进行控制,所以,clang driver 启动后第一个主要任务就是...参数解析 正式分享前,我们先按照惯例分享本文涉及主要 类图 和 流程图,方便 参数解析 主要流程进行理解 Info[1] 是保存了预定义各种 Option 信息结构体。...一、DriverOptTable DriverOptTable 记录了 clang driver 相关 Info 信息,是 OptTable 子类 DriverOptions 模块提供了函数 const...,并做相关校验 具体流程如下: 调用 Driver::getOpts 获取 clang driver 支持所有参数 Info 调用 ParseArgs 解析命令行参数 解析到命令行参数进行判断,...通过 while 原始参数字符串进行遍历,并通过 OptTable::ParseOneArg 方法将所有的原始参数字符串解析为 Arg 实例 最后 Args 会持有所有的解析后参数 通过添加调试代码

    2K40

    面向 C++ 现代 CMake 教程(五)

    正如我们所知,CMake 允许我们使用 Doxygen 来自动生成文档。我们将通过添加 doxygen-awesome-css 样式来进行刷新设计。...(doxygen-awesome-css) 然后,我们需要一个函数来创建生成文档目标。...我们将从第十章《生成文档》中介绍代码中汲取灵感,并进行修改以支持许多目标: chapter-12/01-full-project/cmake/Doxygen.cmake(继续) function(...最后一部分告诉我们如何进行测试,分析,文档,安装和打包自动化。我们研究了 CTest 和测试框架:Catch2,GoogleTest 和 GoogleMock。覆盖率报告也得到了涵盖。...接下来,我们简要介绍了如何使用 Doxygen 生成文档以及如何使其更具吸引力。最后,我们展示了如何将项目安装到系统上,创建可重用 CMake 包,以及如何配置和使用 CPack 生成二进制包。

    12200

    clang 源码导读(4): clang driver 构建 Actions

    正式分享前,我们先按照惯例分享本文涉及主要 类图 和 流程图,方便 参数解析 主要流程进行理解 Action[1] 是执行编译步骤基类,持有Input、Action 类型,产物类型等信息;可以理解为将某种输入转为输出文件操作步骤...构建 Actions 目的是为了满足以下目的: clang driver 需要根据 参数 计算需要进行步骤 比如,当 -emit-llvm 参数传入时,编译器只需要 预处理、编译器前端 两步,不再需要进行...image BuildActions 会先调用 Driver::handleArguments 方法参数进行一些处理 ?...数组,负责记录需要进行 link 操作 JobAction 当某个源码文件需要进行 link 操作时,就会先临时保存到 LinkerInputs 数组 ?...记录需要产出文件架构,比如 arm64 或者 armv7 如果 Arch 数量大于 1,会新增一个 LipoJobAction ,LipoJobAction 会将不同架构二进制合并为一个 fat

    2.2K20

    Doxygen工具简单使用

    简述 Doxygen是一款非常方便文档生成工具,以类似JavaDoc风格描述文档系统,完全支持C、C++、Java等语言,据说也支持python等。...用他不仅可以根据注释生成文档,而且还能利用graphviz工具生成类图以及类中函数调用关系,并且支持html、latex、rtf等格式输出。...生成文档 最简单生成文档方法,就是指定项目目录,输入$doxygen 项目根目录即可在该目录下生成一个html文件夹和latex文件夹,这里面放就是该项目的文档。...RECURSIVE = NO 把这个NO改成YES即可使doxygen递归整个文件树来查找代码。 这样我们就能进行最简单项目文档生成了。...样例 下面是一个叫guisan项目利用doxygen进行文档生成结果: 事实上doxygen不仅能自动生成类属性以及方法说明,还能画出非常复杂类之间继承与聚合等关系图,在分析大型项目的时候还是非常靠谱

    97020

    每天 3 分钟,小闫带你学 Python(十九)

    2.熟悉函数如何定义与调用。 3.了解如何添加函数文档说明。 4.了解函数参数以及返回值。 1.函数 1.1 函数引入介绍 今天开始进入全新章节 -- 函数。...那么如何调用呢? 函数名() 注意函数名后要加小括号进行调用。...def 函数名(参数名): 使用参数进行相关操作 之前定义函数只能输出相同结果,比较死板。现在有一个需求:封装一个函数,实现输出欢迎语句功能。姓名需要在调用时候才能确定,该如何设计?...第一个参数给了已经命名形参 a,后面的参数分配给了不定长参数未命名实参组成一个元组赋值给 args,而命名键值形式参数则赋值给 kwargs。 此处结合示例多思考一下。...规则:调用函数时传入实参按顺序优先分配给命名形参,其余未命名参数组成元组分配给 args,键值则分配给 kwargs。 1.4.5 注意 1.缺省参数必须放在 *args 后面。

    50910

    Java 22 正式发布

    (Implicit Classes and Enhanced Main Methods,预览),该 JEP 包含了前一轮 预览 反馈增强,即 JEP 445,未命名类和实例主方法(预览)。...这个特性通过字符串模板 Java 编程语言进行了增强,字符串模板是包含嵌入式表达式字符串常量,可以在运行时进行解释,嵌入表达式将在运行时进行计算和校验。...这个特性建议“用未命名模和未命名变量来增强语言,前者与记录组件相匹配,但无需说明组件名称和类型,后者可以被初始化但不使用”。...这个特性通过字符串模板 Java 编程语言进行了增强,字符串模板是包含嵌入式表达式字符串常量,可以在运行时进行解释,嵌入表达式将在运行时进行计算和校验。...该 JEP 中变更包括:对本地类处理;将在显式构造函数调用前不能访问字段限制进行了放宽,即在显式构造函数调用前不能读取字段要求。

    18010

    这才是理想中 C 语言编程规范

    结构/枚举必须遵循doxygen文档语法 在声明结构体时,它可以使用以下三种不同选项之一:   1....defined(XYZ) */ 文档 文档代码允许doxygen解析和通用html/pdf/latex输出,因此正确地执行是非常重要。...变量、函数和结构/枚举使用doxygen支持文档样式 经常使用\作为doxygen,不要使用@ 始终使用5x4空格(5个制表符)作为文本行开始偏移量 /** * \brief...< Blue color */ } point_color_t; 函数文档必须在函数实现中编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...这不适用于void函数 函数可以包含其他doxygen关键字,如note或warning 在参数名和描述之间使用冒号: /** * \brief Sum `2` numbers

    2.4K20

    值得一看:老外嵌入式编程规范

    结构/枚举必须遵循doxygen文档语法 在声明结构体时,它可以使用以下三种不同选项之一: 1....defined(XYZ) */ 文档 文档代码允许doxygen解析和通用html/pdf/latex输出,因此正确地执行是非常重要。...变量、函数和结构/枚举使用doxygen支持文档样式 经常使用\作为doxygen,不要使用@ 始终使用5x4空格(5个制表符)作为文本行开始偏移量 /** * \brief...< Blue color */ } point_color_t; 函数文档必须在函数实现中编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...这不适用于void函数 函数可以包含其他doxygen关键字,如note或warning 在参数名和描述之间使用冒号: /** * \brief Sum `2` numbers

    1.2K40

    老外嵌入式编程规范(值得一看)

    结构/枚举必须遵循doxygen文档语法 在声明结构体时,它可以使用以下三种不同选项之一:   1....defined(XYZ) */ 文档 文档代码允许doxygen解析和通用html/pdf/latex输出,因此正确地执行是非常重要。...变量、函数和结构/枚举使用doxygen支持文档样式 经常使用\作为doxygen,不要使用@ 始终使用5x4空格(5个制表符)作为文本行开始偏移量 /** * \brief...< Blue color */ } point_color_t; 函数文档必须在函数实现中编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...这不适用于void函数 函数可以包含其他doxygen关键字,如note或warning 在参数名和描述之间使用冒号: /** * \brief Sum `2` numbers

    1.8K20
    领券