当doxygen注释一个GPU内核时，如何记录网格的信息？

Question

当为一个函数写doxygen注释时，我使用了以下方法 @param 为其参数，我也可以使用 @tparam 的模板参数。然而，当我写一个GPU内核（OpenCL或CUDA）时，我找不到一种方法来记录gridnd-range的选择。

• 维度 - 多少维度?
• 网格的 "轴 "代表什么？哪个维度对应什么参数？
• 每个维度的块(OpenCL工作组)大小、块数和总体大小是多少?

我正在寻找一个合适的doxygen功能来记录这些信息--最好是比一个 @note...

Answer 1

Doxygen不知道计算内核是什么概念。所以它对计算内核的特性没有特别的文档功能，比如工作组大小之类的。所以你得随机应变。

你可以使用内核的主函数，然后把信息放在那里，或者你可以把它放在 @file 文件的文件。