Как правильно документировать описание функции C ++ в doxygen?

Question

У меня есть документ с doxygen следующим образом:

/** @fn
 * Function detailed description
 *
 * @param [in]  param1_name  description of parameter1
 * @param [in]  param2_name  description of parameter2
 * @return return_name return description
 */
uint32_t function_name(uint32_t param1_name, uint32_t param2_name);

Но подробное описание не отображается в doxygen html, я следовал инструкциям со страницы без всякой удачи.

Answer 1

Вам не нужно использовать ключевое слово @fn, если документация по функции размещена непосредственно перед документированной функцией. Попробуйте это:

/** @brief function short description 
 *
 * function longer description if need
 * @param[in]  param1_name  description of parameter1
 * @param[in]  param2_name  description of parameter2
 * @return return_name return description
 */
uint32_t function_name(uint32_t param1_name, uint32_t param2_name);