[docs] Add missing detailed description

include/cantera/equil/vcs_VolPhase.h

@@ -247,9 +247,9 @@ class vcs_VolPhase
      */
     void setState_T(const double temperature_Kelvin);
 
-    // Downloads the ln ActCoeff Jacobian into the VCS version of the
-    // ln ActCoeff Jacobian.
-    /*
+    //! Downloads the ln ActCoeff Jacobian into the VCS version of the
+    //! ln ActCoeff Jacobian.
+    /**
      * This is essentially a scatter operation.
      *
      * @param LnAcJac_VCS Jacobian parameter

include/cantera/equil/vcs_solve.h

@@ -604,7 +604,7 @@ class VCS_SOLVE
 
     //! Recalculate all of the activity coefficients in all of the phases
     //! based on input mole numbers
-    /*
+    /**
      * @param moleSpeciesVCS kmol of species to be used in the update.
      *
      * NOTE: This routine needs to be regulated.

include/cantera/thermo/HMWSoln.h

@@ -1966,7 +1966,7 @@ class HMWSoln : public MolalityVPSSTP
     virtual void applyphScale(doublereal* acMolality) const;
 
 private:
-    /*
+    /**
      * This function will be called to update the internally stored
      * natural logarithm of the molality activity coefficients
      */
@@ -1996,7 +1996,7 @@ class HMWSoln : public MolalityVPSSTP
 
     //! This function will be called to update the internally stored
     //! natural logarithm of the molality activity coefficients
-    /*
+    /**
      * Normally they are all one. However, sometimes they are not,
      * due to stability schemes
      *

include/cantera/thermo/IdealSolnGasVPSS.h

@@ -42,7 +42,7 @@ class IdealSolnGasVPSS : public VPStandardStateTP
     }
 
     //! Set the standard concentration model
-    /*
+    /**
      * Must be one of 'unity', 'species-molar-volume', or 'solvent-molar-volume'.
      */
     void setStandardConcentrationModel(const std::string& model);

include/cantera/thermo/MixtureFugacityTP.h

@@ -352,7 +352,7 @@ class MixtureFugacityTP : public ThermoPhase
 
     //! Calculate the deviation terms for the total entropy of the mixture from
     //! the ideal gas mixture
-    /*
+    /**
      * Here we use the current state conditions
      *
      * @returns the change in entropy in units of J kmol-1 K-1.
@@ -361,7 +361,7 @@ class MixtureFugacityTP : public ThermoPhase
 
     //! Calculate the deviation terms for the total enthalpy of the mixture from
     //! the ideal gas mixture
-    /*
+    /**
      * Here we use the current state conditions
      *
      * @returns the change in entropy in units of J kmol-1.

include/cantera/tpx/utils.h

@@ -6,10 +6,11 @@
 
 namespace tpx
 {
+//! @deprecated To be removed after %Cantera 3.0
 Substance* GetSub(int isub);
 
 //! Create a new Substance object corresponding to the specified name.
-/*
+/**
  * Currently valid substances are:
  *
  * - water

src/kinetics/solveSP.cpp

@@ -1,4 +1,4 @@
-/*
+/**
  * @file: solveSP.cpp Implicit surface site concentration solver
  */
 
@@ -523,7 +523,7 @@ static doublereal calc_damping(doublereal x[], doublereal dxneg[], size_t dim, i
 
 } /* calc_damping */
 
-/*
+/**
  *    This function calculates the norm of an update, dx[], based on the
  *    weighted values of x.
  */

src/thermo/WaterPropsIAPWS.cpp

@@ -29,7 +29,7 @@ static const doublereal M_water = 18.015268;
 static const double R_water = 461.51805; // J/kg/K (Eq. 6.3)
 
 //! Gas constant that is quoted in the paper
-/*
+/**
  * Note, this is the Rgas value quoted in the paper. For consistency
  * we have to use that value and not the updated value
  *

src/thermo/WaterPropsIAPWSphi.cpp

@@ -20,7 +20,7 @@ using std::exp;
 using std::pow;
 using std::fabs;
 
-/*
+/**
  * The added constants were calculated so that u = s = 0
  * for liquid at the triple point. These where determined
  * by the program testPress. I'm not quite satisfied with

src/tpx/Sub.cpp

@@ -1,5 +1,5 @@
-//! @file Sub.cpp
-/*
+/**
+ * @file Sub.cpp
  * The Substance class
  * D. Goodwin, Caltech Nov. 1996
  */