Merge pull request #6514 from akva2/janitoring_doxy

Janitoring: fix some doxy issues

opm/simulators/flow/Transmissibility.hpp

@@ -230,6 +230,7 @@ protected:
     ///
     /// \param cartesianToCompressed Vector containing the compressed index (or -1 for inactive
     ///                              cells) as the element at the cartesian index.
+    /// \param applyNncMultregT      True to apply NNC to region transmissibility multipliers
     void applyPinchNncToGridTrans_(const std::unordered_map<std::size_t,int>& cartesianToCompressed,
                                    bool applyNncMultregT);
 

opm/simulators/flow/equil/EquilibrationHelpers.hpp

@@ -468,7 +468,7 @@ public:
      * \return Dissolved gas-oil ratio (RS) at depth @c
      * depth and pressure @c press.
      */
-    Scalar operator()(const Scalar /* depth */,
+    Scalar operator()(const Scalar depth,
                       const Scalar press,
                       const Scalar temp,
                       const Scalar satGas = 0.0) const override;
@@ -529,7 +529,7 @@ public:
      * \return Dissolved oil-gas ratio (RV) at depth @c
      * depth and pressure @c press.
      */
-    Scalar operator()(const Scalar /*depth*/,
+    Scalar operator()(const Scalar depth,
                       const Scalar press,
                       const Scalar temp,
                       const Scalar satOil = 0.0) const override;
@@ -589,7 +589,7 @@ public:
      * \return Dissolved water-gas ratio (RVW) at depth @c
      * depth and pressure @c press.
      */
-    Scalar operator()(const Scalar /*depth*/,
+    Scalar operator()(const Scalar depth,
                       const Scalar press,
                       const Scalar temp,
                       const Scalar satWat = 0.0) const override;

opm/simulators/linalg/gpuistl/GpuSparseMatrixWrapper.hpp

@@ -105,7 +105,7 @@ public:
     //! \param[in] nonZeroElements the non-zero values of the matrix
     //! \param[in] rowIndices      the row indices of the non-zero elements
     //! \param[in] columnIndices   the column indices of the non-zero elements
-    //! \param[in] numberOfNonzeroElements number of nonzero elements
+    //! \param[in] numberOfNonzeroBlocks number of nonzero blocks
     //! \param[in] blockSize size of each block matrix (typically 3)
     //! \param[in] numberOfRows the number of rows
     //!
@@ -351,8 +351,9 @@ public:
 
     /**
      * @brief umv computes y=alpha * Ax + y
+     * @param[in] alpha Scaling factor
      * @param[in] x the vector to multiply with A
-     * @param[inout] y the vector to add and store the output in
+     * @param[in,out] y the vector to add and store the output in
      */
     virtual void usmv(T alpha, const GpuVector<T>& x, GpuVector<T>& y) const
     {