c - 如何使用 doxygen 中的静态数组索引说明符函数参数正确记录 C 数组?
问题描述
我有以下 C 函数,我想为它生成 doxygen 文档
//! Function description
/*!
\param paramA[][] description
\param paramB[] description
!*/
static void foo(
int paramA[static const A_DIM1_SIZE][A_DIM2_SIZE],
int paramB[static const B_DIM1_SIZE]);
Doxygen 给了我这个警告
warning: parameters of member foo are not (all) documented
我认为这个错误是由于static const
数组括号内部造成的,因为我在我的代码库中用类似的 doxygen 语法记录了其他数组函数参数,static const
它们的括号内没有,并且 doxygen 没有抱怨。
遗憾的是,我无法找到解释使用 doxygenstatic const
在括号内记录数组时使用的正确语法的指南。
解决方案
推荐阅读
- javascript - 对于使用推荐链接访问我的网站的用户。我可以捕获访问者的来源/媒体吗?
- r - 通过R中的变量将值传递给函数
- node.js - 我可以使用 OPC UA 中的路径读取值吗?
- laravel - Laravel DB::raw 参数
- php - unlink(202104241126Dell_Logo.png):没有这样的文件或目录
- windows - DesktopInfo 作为 Windows 服务已启动,但没有任何反应
- django - 我如何使用 Django gabarit 过滤通过模型的条件
- python - Fast.ai & NLP:删除 fast.ai 分词器中的未知词
- java - 使用 Elasticsearch 编译 java 文件
- python - “警告:scheme.data 的值不匹配”当我尝试更新 pip 或安装软件包时