diff --git a/include/cantera/equil/vcs_VolPhase.h b/include/cantera/equil/vcs_VolPhase.h index d8b8a6cd41..e56b509547 100644 --- a/include/cantera/equil/vcs_VolPhase.h +++ b/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 diff --git a/include/cantera/equil/vcs_solve.h b/include/cantera/equil/vcs_solve.h index ef9b0e1aed..947a0110de 100644 --- a/include/cantera/equil/vcs_solve.h +++ b/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. diff --git a/include/cantera/thermo/HMWSoln.h b/include/cantera/thermo/HMWSoln.h index 989ac39bea..0f97d8d707 100644 --- a/include/cantera/thermo/HMWSoln.h +++ b/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 * diff --git a/include/cantera/thermo/IdealSolnGasVPSS.h b/include/cantera/thermo/IdealSolnGasVPSS.h index 8eff554026..6dc45f522d 100644 --- a/include/cantera/thermo/IdealSolnGasVPSS.h +++ b/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); diff --git a/include/cantera/thermo/MixtureFugacityTP.h b/include/cantera/thermo/MixtureFugacityTP.h index 2d468d8e1d..effef21ee4 100644 --- a/include/cantera/thermo/MixtureFugacityTP.h +++ b/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. diff --git a/include/cantera/tpx/utils.h b/include/cantera/tpx/utils.h index 08b170523f..1182b1a322 100644 --- a/include/cantera/tpx/utils.h +++ b/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 diff --git a/src/kinetics/solveSP.cpp b/src/kinetics/solveSP.cpp index df1f9f5d9b..5c3570b94c 100644 --- a/src/kinetics/solveSP.cpp +++ b/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. */ diff --git a/src/thermo/WaterPropsIAPWS.cpp b/src/thermo/WaterPropsIAPWS.cpp index 10b688b077..9ea9561c11 100644 --- a/src/thermo/WaterPropsIAPWS.cpp +++ b/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 * diff --git a/src/thermo/WaterPropsIAPWSphi.cpp b/src/thermo/WaterPropsIAPWSphi.cpp index 40444fec84..050d6dc122 100644 --- a/src/thermo/WaterPropsIAPWSphi.cpp +++ b/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 diff --git a/src/tpx/Sub.cpp b/src/tpx/Sub.cpp index c2dcf79089..2012966154 100644 --- a/src/tpx/Sub.cpp +++ b/src/tpx/Sub.cpp @@ -1,5 +1,5 @@ -//! @file Sub.cpp -/* +/** + * @file Sub.cpp * The Substance class * D. Goodwin, Caltech Nov. 1996 */