在对 GPU 内核进行 doxygen 注释时，如何记录有关网格的信息？

Posted 2023-03-23

【中文标题】在对 GPU 内核进行 doxygen 注释时，如何记录有关网格的信息？

【英文标题】：When doxygen-commenting a GPU kernel, how do I document information about the grid?

【发布时间】：2020-08-19 01:46:46

【问题描述】：

在为函数编写 doxygen 注释时，我使用@param 作为它的参数，我也可以使用@tparam 作为它的模板参数。但是，在编写 GPU 内核（OpenCL 或 CUDA）时，我无法找到一种方法来记录 w.r.t 的选择。网格/nd 范围：

维度 - 多少个维度？ 网格的“轴”表示什么？哪个维度对应什么参数？ 每个维度中的块（OpenCL 工作组）大小、块数和/或总体大小是多少？

我正在寻找合适的 doxygen 功能，用于在评论中记录此信息 - 最好比 @note...

【问题讨论】：

还举个例子说明你有/想要完成什么。哪个 doxygen 版本？

@albert：读取源代码的系统上的 doxygen 版本是什么。如果仅在最近的 doxygen 版本中有一些功能，请告诉我。

我不知道系统上的doxygen版本是哪个，也许doxygen -v会发光。第二句话我不明白。请创建一个 MWE 来显示您的问题。

可能是一个 doxygen @page ？

@MarcAlff：你能扩展一下吗？

【参考方案1】：

Doxygen 不知道计算内核是什么概念。因此它没有针对计算内核特性的特殊文档特性，如工作组大小等。所以你将不得不即兴发挥。

您可以使用内核的 main 函数并将信息放在那里，或者您可以将其放入文件的 @file 文档中。