FS#315 "using" command interferes with doxygen
Metadata
Property | Value |
---|---|
Project | dumux |
Category | Documentation |
Reported by | Martin Beck (martin.beck@iws.uni-stuttgart.de) |
Reported at | Feb 24, 2016 10:35 |
Type | DuMuX day |
Version | Git |
Last edited by | Johannes Hommel (johannes.hommel@iws.uni-stuttgart.de) |
Last edited at | Jul 27, 2016 07:08 |
Closed by | Johannes Hommel (johannes.hommel@iws.uni-stuttgart.de) |
Closed at | Jul 27, 2016 07:08 |
Closed in version | unknown (Id=0) |
Resolution | Implemented |
Description
While working on an update for the description of some functions of the fluidsystems, I noticed that my changes do not appear in the doxygen. After a bit of investigation, I found out that the "using" command is to be blamed. Apparently, it copies the description of the function, to which the "using" command refers to and ignores the description of the actual function. One example: For the enthalpy function of the brine-air fluid system, the description of the base fluid systems shows up instead of the specific description where some references are provided. So this information is lost and one becomes only aware of if one goes through the source code.