Когда doxygen-комментирует ядро ​​GPU, как мне документировать информацию о сетке? - PullRequest
1 голос
/ 04 мая 2020

При написании комментария doxygen для функции я использую @param для ее параметров, а также могу использовать @tparam для ее параметров шаблона. Тем не менее, при написании ядра графического процессора (OpenCL или CUDA) я не могу найти способ документировать варианты выбора с помощью grid / nd-range:

  • Размерность - сколько измерений?
  • Что означают "оси" сетки? Какому измерению соответствует какой параметр?
  • Что такое размеры блоков (рабочая группа OpenCL), количество блоков и / или общий размер в каждом измерении?

Я ищу соответствующая функция doxygen для записи этой информации в комментарии - желательно лучше, чем @note ...

1 Ответ

2 голосов
/ 04 мая 2020

Doxygen понятия не имеет, что такое вычислительное ядро. Таким образом, он не имеет специальных функций документации для функций вычислительных ядер, таких как размер рабочей группы и тому подобное. Поэтому вам придется импровизировать.

Вы можете использовать основную функцию для ядра и поместить туда информацию, или вы можете поместить ее в документацию @file для файла.

...