CODEWITHSUNDEEP
doxygen
John Griswold
John Griswold

Reputation: 21

Why do I get an "unexpected token" error in Doxygen?

I'm a relative neophyte to Doxygen, but I thought I understood how to write a comment. I have a few stragglers now, complaining of "warning: unexpected token in comment block while parsing the argument of command param" on the following comment, complaining about the @brief line.

/**
  * @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
  */

Can anybody tell me what might be the unexpected token? I've even resorted to retyping the comment block thinking I had an invisible character in there. (It's happened before...).

I didn't find anything in the Doxygen documentation that mentioned error messages.

And of course I assume I'm being particularly dense and stupid today...

Upvotes: 0

Views: 1623

Answers (1)

John Griswold
John Griswold

Reputation: 21

Figured it out. Lazy sot that I am, I kept an empty Doxygen comment block around that I could just copy and paste when I added a new function:

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

Well (empirically, anyway) it turns out that if you have a real comment block after that, say:

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

Doxygen gets confused. John gets confused.

So, mea culpa, but I found the problem.

Upvotes: 1

Related Questions