Я использую Doxygen для генерации HTML-файлов для проекта C, и у меня есть несколько состояний и предупреждений. Я задокументировал функции состояния и предупреждения в C, но я хотел бы извлечь комментарий в файл уценки.
Я знаю, что могу использовать @ref имя_функции для создания ссылки на функцию, в которой будут отображаться комментарии, но я хочу, чтобы они собирались на той же странице уценки и добавляли дополнительные комментарии, которые не подходят для исходного кода, без приходится копировать вставлять их вручную.
Я просмотрел документацию по Doxygen и сеть, но не нашел решения. Есть ли команда или другой подход, который может мне помочь?
Пример кода
/**
* @brief This is a function
*
* @detailed This function does stuff.
*
* @param bar Value that has no meaning
*
* @return Another value
*/
void foo(int bar)
{
return 0;
}
Как бы я хотел извлечь комментарий в файле уценки.
@ref_doc_detailed foo()
That you could never imagine.
Результат, который я хотел бы получить при создании файлов HTML.
This function does stuff.
That you could never imagine