Skip to content

Move doxygen documentation for classes and functions to actual classes and functions

Anna Wellmann requested to merge m.schoenherr/VirtualFluids_dev:fixDoxygenModules into develop

This merge adresses the problem stated in #187 (closed).

I moved the \brief and \details sections from the header to the definition of the classes or functions. In some cases, I also duplicate descriptions from cpp files.

These are the affected files:

  • EdgeNodeFinder
  • MultipleGridBuilderFacade
  • DragLift
  • IndexRearrangementForStreams
  • InterpolationCellGrouper
  • DistributionDebugInspector
  • Probe and its subclasses
  • PrecurserWriter
  • K17CompressibleNavierStokes

To avoid the problem in the future, we should not put \brief or \details for functions or classes in the file header anymore.

Merge request reports