FS#136 Make \\copydoc consistent
Metadata
Description
This is the appendix of FS#23. Klaus wrote:
[using \\copydoc]
The problem is that if the arguments have different names in the derived class as in the parent class (where the documentation is copied from), Doxygen will spit out warnings and the names of the arguments are taken from the parent class. That means they won\'t fit to the argument names of the actually documented function.
[..]
- If \\copydoc is used, the argument names should be exactly the same; thus we can agree for these cases on some fixed names (at least for common object names such as fvElementGeometry, scvIdx/vertexIdx, etc.). So far, these names are varying sometimes even within one file, which is in my opinion not too consistent.
- Moreover, we could keep the issue with the argument names in mind when creating new methods and documenting them with \\copydoc.
