Merge branch 'cleanup/fluidsAndFluidsystems' into 'master'

cleanup comments in fluidsystems

See merge request !3779

dumux/material/fluidsystems/h2on2.hh

@@ -57,14 +57,14 @@ class H2ON2
 {
     using ThisType = H2ON2<Scalar, Policy>;
 
-    // convenience using declarations
+    // convenience aliases using declarations
     using IdealGas = Dumux::IdealGas<Scalar>;
     using TabulatedH2O = Components::TabulatedComponent<Dumux::Components::H2O<Scalar> >;
     using SimpleN2 = Dumux::Components::N2<Scalar>;
 
 public:
-    using H2O = TabulatedH2O; //!< The components for pure water
-    using N2 = SimpleN2; //!< The components for pure nitrogen
+    using H2O = TabulatedH2O; //!< The component for pure water
+    using N2 = SimpleN2; //!< The component for pure nitrogen
 
     static constexpr int numPhases = 2; //!< Number of phases in the fluid system
     static constexpr int numComponents = 2; //!< Number of components in the fluid system

dumux/material/fluidsystems/parametercachebase.hh

@@ -80,7 +80,7 @@ public:
      *        which depend on temperature
      *
      * \b Only use this method if only the temperature of a phase
-     * changed between two update*() calls. If more changed, call
+     * changed between two update() calls. If more changed, call
      * updatePhase()!
      */
     template <class FluidState>
@@ -94,7 +94,7 @@ public:
      *        which depend on pressure
      *
      * \b Only use this method if only the pressure of a phase changed
-     * between two update*() calls. If more changed, call
+     * between two update() calls. If more changed, call
      * updatePhase()!
      */
     template <class FluidState>
@@ -108,7 +108,7 @@ public:
      *        which depend on composition
      *
      * \b Only use this method if neither the pressure nor the
-     * temperature of the phase changed between two update*()
+     * temperature of the phase changed between two update()
      * calls. If more changed, call updatePhase()!
      */
     template <class FluidState>
@@ -122,7 +122,7 @@ public:
      *        which depend on the mole fraction of a single component
      *
      * \b Only use this method if just a single component's
-     * concentration changed between two update*() calls. If more than
+     * concentration changed between two update() calls. If more than
      * one concentration changed, call updatePhaseComposition() of
      * updatePhase()!
      */

dumux/material/fluidsystems/spe5parametercache.hh

@@ -84,7 +84,7 @@ public:
      *        which depend on the mole fraction of a single component
      *
      * \b Only use this method if just a single component's
-     * concentration changed between two \p update*() calls. If more than
+     * concentration changed between two \p update() calls. If more than
      * one concentration changed, call updatePhaseComposition() of
      * updatePhase()!