Skip to main content
gw48
Associate II
April 3, 2020
Question

Generated files have numerous Doxygen warnings

  • April 3, 2020
  • 1 reply
  • 1662 views

STM32CubeIDE — brand new project with HAL, no user code yet.

Generated code includes `@param None` and `@result None` — so Dox is looking for a parameter in the function named `None` — and that in turn is generating an error which is rendered in Eclipse (when using the doxygen plugin).

The authors of the generated code have done this in many, many places which is littering the IDE text editor with dozens of warnings.

These need to be removed. If there's no paramters, do not include @param. If there is not return value, do not include @return. If there's a need to state these things explicitly (I don't think there is), it should be written in the @brief — perhaps as "No params. No return value."

This topic has been closed for replies.

1 reply

BHoff
Associate
August 27, 2020

I have the same problem.

But maybe there is a possibility to suppress the warning in Doxygen? I had a look for it, but didn't find any...