Почему я получаю «неожиданную ошибку» в Doxygen? - PullRequest
Новая
       15

Почему я получаю «неожиданную ошибку» в Doxygen?

0 голосов
/ 02 октября 2018

Я относительный неофит к Doxygen, но мне показалось, что я понял, как написать комментарий.У меня есть несколько отставших, которые жаловались на «предупреждение: неожиданный токен в блоке комментариев при анализе аргумента командной строки» на следующий комментарий, жалуясь на строку @brief. 

/**
  * @brief  Converts ADC reading to battery voltage
  * @param  adcVal raw ADC reading
  * @retval Battery voltage as float
  * @note   Assumes 12 bit ADC and 3.3 volt VCC
  * @note   Broken out for testability
  */

Может кто-нибудь сказать мнечто может быть неожиданным токеном?Я даже прибег к повторному вводу блока комментариев, думая, что там есть невидимый персонаж.(Это случилось раньше ...).

Я не нашел ничего в документации Doxygen, в которой упоминались бы сообщения об ошибках.

И, конечно, я полагаю, что я сегодня очень дремучий и глупый...

1 Ответ

0 голосов
/ 02 октября 2018

Разобрался.Я ленивый, я держал пустой блок комментариев Doxygen, который я мог просто скопировать и вставить, когда добавил новую функцию: 

/**
    *   @brief
    *   @param
    *   @param
    *   @param
    *   @retval
    *   @note
    */

Ну (эмпирически, во всяком случае) получается, что если у вас есть реальный блок комментариев после этого, скажите: 

/**
  * @brief this is a dummy function
  * @param x is the input argument
  */

Doxygen запутался.Джон запутался.

Итак, я виноват, но я нашел проблему.

...