better comments

Author: pcarruscag

Common/include/toolboxes/C1DInterpolation.hpp

@@ -1,6 +1,6 @@
 /*!
  * \file C1DInterpolation.hpp
- * \brief Inlet_interpolation_functions
+ * \brief Classes for 1D interpolation.
  * \author Aman Baig, P. Gomes
  * \version 7.1.1 "Blackbird"
  *
@@ -89,7 +89,7 @@ class CAkimaInterpolation: public C1DInterpolation{
 
   /*!
    * \brief Constructor of the CAkimaInterpolation class.
-   * \param[in] X - the x values.
+   * \param[in] X - the x values (sorted low to high).
    * \param[in] Data - the f(x) values.
    */
   CAkimaInterpolation(const std::vector<su2double> &X, const std::vector<su2double> &Data) {
@@ -120,7 +120,7 @@ class CCubicSpline final: public CAkimaInterpolation {
 
   /*!
    * \brief Constructor of the CCubicSpline class (defaults to natural spline).
-   * \param[in] X - the x values.
+   * \param[in] X - the x values (sorted low to high).
    * \param[in] Data - the f(x) values.
    * \param[in] startCondition - 1st or 2nd derivative imposed at the start.
    * \param[in] startValue - value of the derivative imposed at the start.
@@ -149,7 +149,7 @@ class CLinearInterpolation final: public C1DInterpolation {
 
   /*!
    * \brief Constructor of the CLinearInterpolation class.
-   * \param[in] X - the x values.
+   * \param[in] X - the x values (sorted low to high).
    * \param[in] Data - the f(x) values.
    */
   CLinearInterpolation(const std::vector<su2double> &X, const std::vector<su2double> &Data) {

Common/src/toolboxes/C1DInterpolation.cpp

@@ -1,7 +1,7 @@
 /*!
  * \file C1DInterpolation.cpp
- * \brief Inlet_interpolation_functions
- * \author Aman Baig
+ * \brief Classes for 1D interpolation.
+ * \author Aman Baig, P. Gomes
  * \version 7.1.1 "Blackbird"
  *
  * SU2 Project Website: https://su2code.github.io