Skip to content

cleanup/resolve doxygen fluidsystem warnings

Fixes doxygen warnings in the fluid system. Doxygen seems to have issues when bringing in functions from a base class, in the context of CRTP-like inheritance, via an alias. Moreover, copybriefing docs from the base class have to occur with the specific overload one wants to bring in, otherwise one gets an error from undocumented parameters. The original code had further issues, which are fixed with this MR

  • Our fluid system functions usuall have two overloads (with and w/o ParameterCache). However, the rendered docs showed 4 overloads, probably due to the issue mentioned above.
  • In some places, using Base:: was placed below the doxygen documentation, which renders wrong.
  • Sometimes the empty line between the brief and long descriptions were missing (there's probably still more occurrences of that)
  • Fixes the ordering between params and long description in the base fluid system

Further changes in this MR:

  • when the function docs in derived fluid systems did not add anything to that of the base, they were replaced with a copydoc command

depends on !3439 (merged)

Edited by Dennis Gläser

Merge request reports

Loading