FS#287 Unify doxygen comments for properties
Metadata
| Property | Value |
|---|---|
| Project | dumux |
| Category | General |
| Reported by | Kilian Weishaupt (kilian.weishaupt@iws.uni-stuttgart.de) |
| Reported at | Aug 21, 2015 14:38 |
| Type | Bug Report |
| Version | Git |
| Last edited by | Kilian Weishaupt (kilian.weishaupt@iws.uni-stuttgart.de) |
| Last edited at | Jan 22, 2016 09:48 |
| Closed by | Kilian Weishaupt (kilian.weishaupt@iws.uni-stuttgart.de) |
| Closed at | Jan 22, 2016 09:48 |
| Closed in version | 2.9 |
| Resolution | Won't implement |
Description
In doxygen's Dumux::Properties Namespace Reference,for several properties (e.g., Fluidsytem) a multitude of different comments have been assigned in the various models.
These comments should be unified so that there will be only one single comment for each property.
We should probably use the opportunity to do this while changing the folder structure after 2.7. Since various properties will be declared on a higher level for several models, this will automatically reduce redundancy and the number of different comments for the same property.
Only some "special" properties that are only used by certain models might have to be changed manually.
So far, the following properties have multiple comments:
Property tag Dumux::Properties::WettingPhase Property tag Dumux::Properties::VtkAddVelocity Property tag Dumux::Properties::VisitFacesOnlyOnce Property tag Dumux::Properties::VertexMapper Property tag Dumux::Properties::VelocityFormulation Property tag Dumux::Properties::VelocityAveragingInModel Property tag Dumux::Properties::UseMoles Property tag Dumux::Properties::UseConstraintSolver Property tag Dumux::Properties::TimeManagerMaxTimeStepSize Property tag Dumux::Properties::TimeManager Property tag Dumux::Properties::SpatialParamsForchCoeff Property tag Dumux::Properties::SpatialParams Property tag Dumux::Properties::SolutionVector Property tag Dumux::Properties::SaturationFormulation Property tag Dumux::Properties::ReplaceCompEqIdx Property tag Dumux::Properties::ProblemEnableGravity Property tag Dumux::Properties::PressureGridFunctionSpace Property tag Dumux::Properties::PressureFormulation Property tag Dumux::Properties::PressureFEM Property tag Dumux::Properties::PhaseIdx Property tag Dumux::Properties::NumPhases Property tag Dumux::Properties::NumComponents Property tag Dumux::Properties::NonwettingPhase Property tag Dumux::Properties::NewtonWriteConvergence Property tag Dumux::Properties::NewtonUseLineSearch Property tag Dumux::Properties::NewtonTargetSteps Type tag Dumux::Properties::NewtonMethod Property tag Dumux::Properties::NewtonController Property tag Dumux::Properties::Model Property tag Dumux::Properties::MaterialLawParams Property tag Dumux::Properties::MaterialLaw Property tag Dumux::Properties::LinearSolverVerbosity Property tag Dumux::Properties::LinearSolverBlockSize Property tag Dumux::Properties::JacobianMatrix Property tag Dumux::Properties::JacobianAssembler Property tag Dumux::Properties::Indices Property tag Dumux::Properties::ImplicitNumericDifferenceMethod Property tag Dumux::Properties::ImplicitMobilityUpwindWeight Property tag Dumux::Properties::ImplicitMassUpwindWeight Property tag Dumux::Properties::ImplicitEnablePartialReassemble Property tag Dumux::Properties::ImplicitEnableHints Property tag Dumux::Properties::ImpetErrorTermUpperBound Property tag Dumux::Properties::ImpetErrorTermLowerBound Property tag Dumux::Properties::ImpetErrorTermFactor Property tag Dumux::Properties::GridOperatorSpace Property tag Dumux::Properties::GridOperator Property tag Dumux::Properties::GridAdaptEnableInitializationIndicator Property tag Dumux::Properties::Grid Property tag Dumux::Properties::FluidSystem Property tag Dumux::Properties::FluidState Property tag Dumux::Properties::Fluid Property tag Dumux::Properties::DisplacementGridFunctionSpace Property tag Dumux::Properties::DisplacementFEM Property tag Dumux::Properties::CellData Property tag Dumux::Properties::BaseModel Property tag Dumux::Properties::BaseFluxVariables
Maybe it would be a good idea to form a group (similar to the handbook team) in order to discuss which comments should be used and/or improved.