Doxygen shows descriptions of class in module view
When viewing the modules in Doxygen you sometimes see misleading descriptions.
For example the description for Parameter
is wrong here:
(image from https://irmb.gitlab-pages.rz.tu-bs.de/VirtualFluids/group__gpu__core.html)
For the folder Parameter
Doxygen shows the description for EdgeNodeFinder
. The description
is generated in the header of EdgeNodeFinder in the following way:
//! \addtogroup gpu_Parameter Parameter
//! \ingroup gpu_core core
//! \{
//! \author Anna Wellmann
//! \brief Functions for finding edge nodes in the multi-gpu implementation
//! \details Edge nodes are nodes, which are part of the communication in multiple directions
//! \ref master thesis of Anna Wellmann (p. 54-57)
This description is correct for the EdgeNodeFinder but it does not fit the entire folder Parameter.
This problem occurs in gpu/core, gpu/grid_gridgenerator, lbm.