Skip to content

Doxygen: Treat Warnings As Errors

Simon Spannagel requested to merge fix_doxygen into master

This MR arms Doxygen properly. The WARN_AS_ERROR now treats warnings encountered during documentation generation as errors, and hence the respective CI job will fail. Together with the other warning switches set to ON in the Doxyfile, this means incoming code is always checked for

  • Properly documenting all methods and parameters thereof
  • Having correct cross-reference links
  • Including the correct source files in the Doxygen build.

Should probably have done this much earlier. 😉

Merge request reports