Skip to content

Commit

Permalink
[docs] Make Doxygen style more consistent (con't)
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl authored and speth committed Aug 1, 2023
1 parent 30d3412 commit 5b07e7f
Show file tree
Hide file tree
Showing 98 changed files with 150 additions and 150 deletions.
28 changes: 14 additions & 14 deletions doc/doxygen/thermoprops.dox
Original file line number Diff line number Diff line change
Expand Up @@ -176,90 +176,90 @@
*
* <TABLE>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_TPX() setState_TPX()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_TPX() setState_TPX()@endlink </TD>
* <TD> Sets the temperature, mole fractions and then the pressure
* of the phase. </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_TPY() setState_TPY()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_TPY() setState_TPY()@endlink </TD>
* <TD> Set the temperature, mass fractions and then the pressure
* of the phase. </TD>
* </TR>
* <TR>
* <TD> \link Cantera::MolalityVPSSTP::setState_TPM() setState_TPM()\endlink </TD>
* <TD> @link Cantera::MolalityVPSSTP::setState_TPM() setState_TPM()@endlink </TD>
* <TD> Set the temperature, solute molalities, and then the
* pressure of the phase. Only from %ThermoPhase objects which
* inherit from MolalityVPSSTP
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_TP() setState_TP()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_TP() setState_TP()@endlink </TD>
* <TD> Set the temperature, and then the pressure
* of the phase. The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_PX() setState_PX()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_PX() setState_PX()@endlink </TD>
* <TD> Set the mole fractions and then the pressure
* of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_PY() setState_PY()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_PY() setState_PY()@endlink </TD>
* <TD> Set the mass fractions and then the pressure
* of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_HP() setState_HP()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_HP() setState_HP()@endlink </TD>
* <TD> Set the total specific enthalpy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_UV() setState_UV()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_UV() setState_UV()@endlink </TD>
* <TD> Set the total specific internal energy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_SP setState_SP()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_SP setState_SP()@endlink </TD>
* <TD> Set the total specific internal energy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setState_SV setState_SV()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setState_SV setState_SV()@endlink </TD>
* <TD> Set the total specific entropy and the total specific
* molar volume of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::Phase::setConcentrations setConcentrations()\endlink </TD>
* <TD> @link Cantera::Phase::setConcentrations setConcentrations()@endlink </TD>
* <TD> Set the concentrations of all the species in the
* phase. Note this implicitly specifies the pressure and
* density of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::Phase::setDensity setDensity()\endlink </TD>
* <TD> @link Cantera::Phase::setDensity setDensity()@endlink </TD>
* <TD> Set the total density of the phase. The temperature and
* mole fractions are assumed fixed. Note this implicitly
* sets the pressure of the phase.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::Phase::setTemperature() setTemperature()\endlink </TD>
* <TD> @link Cantera::Phase::setTemperature() setTemperature()@endlink </TD>
* <TD> Set the temperature of the phase. The density and
* the mole fractions of the phase are fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Cantera::ThermoPhase::setToEquilState() setToEquilState()\endlink </TD>
* <TD> @link Cantera::ThermoPhase::setToEquilState() setToEquilState()@endlink </TD>
* <TD> Sets the mole fractions of the phase to their
* equilibrium values assuming fixed temperature and
* total density.
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/Units.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file Units.h
* Header for unit conversion utilities, which are used to translate
* user input from input files (See @ref inputGroup and
* class \link Cantera::Units Units\endlink).
* class @link Cantera::Units Units@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/logger.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file logger.h
* Header for Base class for 'loggers' that write text messages to log files
* (see @ref logGroup and class \link Cantera::Logger Logger\endlink).
* (see @ref logGroup and class @link Cantera::Logger Logger@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/equil/MultiPhase.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @file MultiPhase.h
* Headers for the \link Cantera::MultiPhase MultiPhase\endlink
* Headers for the @link Cantera::MultiPhase MultiPhase@endlink
* object that is used to set up multiphase equilibrium problems (see @ref equilGroup).
*/

Expand Down
4 changes: 2 additions & 2 deletions include/cantera/equil/vcs_solve.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file vcs_solve.h Header file for the internal object that holds the vcs
* equilibrium problem (see Class \link Cantera::VCS_SOLVE
* VCS_SOLVE\endlink and @ref equilGroup ).
* equilibrium problem (see Class @link Cantera::VCS_SOLVE
* VCS_SOLVE@endlink and @ref equilGroup ).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/ImplicitSurfChem.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file ImplicitSurfChem.h
* Declarations for the implicit integration of surface site density equations
* (see @ref kineticsmgr and class
* \link Cantera::ImplicitSurfChem ImplicitSurfChem\endlink).
* @link Cantera::ImplicitSurfChem ImplicitSurfChem@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/Kinetics.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file Kinetics.h
* Base class for kinetics managers and also contains the kineticsmgr
* module documentation (see @ref kineticsmgr and class
* \link Cantera::Kinetics Kinetics\endlink).
* @link Cantera::Kinetics Kinetics@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/ReactionRateFactory.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file ReactionRateFactory.h
* Factory class for reaction rate objects. Used by classes that implement kinetics
* (see @ref reactionGroup and class \link Cantera::ReactionRate ReactionRate\endlink).
* (see @ref reactionGroup and class @link Cantera::ReactionRate ReactionRate@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/solveSP.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @file solveSP.h Header file for implicit surface problem solver (see @ref
* chemkinetics and class \link Cantera::solveSP solveSP\endlink).
* chemkinetics and class @link Cantera::solveSP solveSP@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/numerics/BandMatrix.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file BandMatrix.h
* Declarations for the class BandMatrix
* which is a child class of GeneralMatrix for banded matrices handled by solvers
* (see class @ref numerics and \link Cantera::BandMatrix BandMatrix\endlink).
* (see class @ref numerics and @link Cantera::BandMatrix BandMatrix@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/numerics/DenseMatrix.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file DenseMatrix.h
* Headers for the DenseMatrix object, which deals with dense rectangular matrices and
* description of the numerics groupings of objects
* (see @ref numerics and \link Cantera::DenseMatrix DenseMatrix \endlink) .
* (see @ref numerics and @link Cantera::DenseMatrix DenseMatrix @endlink) .
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/numerics/GeneralMatrix.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file GeneralMatrix.h
* Declarations for the class GeneralMatrix which is a virtual base class for matrices handled by solvers
* (see class @ref matrices and \link Cantera::GeneralMatrix GeneralMatrix\endlink).
* (see class @ref matrices and @link Cantera::GeneralMatrix GeneralMatrix@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/BinarySolutionTabulatedThermo.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file BinarySolutionTabulatedThermo.h
* Header file for an binary solution model with tabulated standard state
* thermodynamic data (see @ref thermoprops and class
* \link Cantera::BinarySolutionTabulatedThermo BinarySolutionTabulatedThermo\endlink).
* @link Cantera::BinarySolutionTabulatedThermo BinarySolutionTabulatedThermo@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/ConstCpPoly.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @file ConstCpPoly.h
* Headers for the \link Cantera::SpeciesThermoInterpType SpeciesThermoInterpType\endlink
* Headers for the @link Cantera::SpeciesThermoInterpType SpeciesThermoInterpType@endlink
* object that employs a constant heat capacity assumption (see @ref spthermo and
* \link Cantera::ConstCpPoly ConstCpPoly\endlink).
* @link Cantera::ConstCpPoly ConstCpPoly@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/CoverageDependentSurfPhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* phase derived from SurfPhase, applying adsorbate lateral interaction
* correction factors to the SurfPhase thermodynamic properties.
* (see @ref thermoprops and class
* \link Cantera::CoverageDependentSurfPhase CoverageDependentSurfPhase\endlink).
* @link Cantera::CoverageDependentSurfPhase CoverageDependentSurfPhase@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/DebyeHuckel.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file DebyeHuckel.h
* Headers for the DebyeHuckel ThermoPhase object, which models dilute
* electrolyte solutions
* (see @ref thermoprops and \link Cantera::DebyeHuckel DebyeHuckel \endlink) .
* (see @ref thermoprops and @link Cantera::DebyeHuckel DebyeHuckel @endlink) .
*
* Class DebyeHuckel represents a dilute liquid electrolyte phase which
* obeys the Debye Huckel formulation for nonideality.
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/EdgePhase.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file EdgePhase.h Declarations for the EdgePhase ThermoPhase object, which
* models the interface between two surfaces (see @ref thermoprops and
* \link Cantera::EdgePhase EdgePhase\endlink).
* @link Cantera::EdgePhase EdgePhase@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/GibbsExcessVPSSTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Header for intermediate ThermoPhase object for phases which
* employ Gibbs excess free energy based formulations
* (see @ref thermoprops
* and class \link Cantera::GibbsExcessVPSSTP GibbsExcessVPSSTP\endlink).
* and class @link Cantera::GibbsExcessVPSSTP GibbsExcessVPSSTP@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/HMWSoln.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file HMWSoln.h
* Headers for the HMWSoln ThermoPhase object, which models concentrated
* electrolyte solutions
* (see @ref thermoprops and \link Cantera::HMWSoln HMWSoln \endlink) .
* (see @ref thermoprops and @link Cantera::HMWSoln HMWSoln @endlink) .
*
* Class HMWSoln represents a concentrated liquid electrolyte phase which
* obeys the Pitzer formulation for nonideality using molality-based
Expand Down
6 changes: 3 additions & 3 deletions include/cantera/thermo/IdealGasPhase.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file IdealGasPhase.h
* ThermoPhase object for the ideal gas equation of
* state - workhorse for %Cantera (see @ref thermoprops
* and class \link Cantera::IdealGasPhase IdealGasPhase\endlink).
* and class @link Cantera::IdealGasPhase IdealGasPhase@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down Expand Up @@ -33,8 +33,8 @@ namespace Cantera
*
* It is assumed that the reference state thermodynamics may be obtained by a
* pointer to a populated species thermodynamic property manager class in the
* base class, ThermoPhase::m_spthermo (see the base class \link
* Cantera::MultiSpeciesThermo MultiSpeciesThermo \endlink for a description of
* base class, ThermoPhase::m_spthermo (see the base class @link
* Cantera::MultiSpeciesThermo MultiSpeciesThermo @endlink for a description of
* the specification of reference state species thermodynamics functions). The
* reference state, where the pressure is fixed at a single pressure, is a key
* species property calculation for the Ideal Gas Equation of state.
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/IdealMolalSoln.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file IdealMolalSoln.h
* ThermoPhase object for the ideal molal equation of
* state (see @ref thermoprops
* and class \link Cantera::IdealMolalSoln IdealMolalSoln\endlink).
* and class @link Cantera::IdealMolalSoln IdealMolalSoln@endlink).
*
* Header file for a derived class of ThermoPhase that handles variable pressure
* standard state methods for calculating thermodynamic properties that are
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/IdealSolidSolnPhase.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file IdealSolidSolnPhase.h Header file for an ideal solid solution model
* with incompressible thermodynamics (see @ref thermoprops and
* \link Cantera::IdealSolidSolnPhase IdealSolidSolnPhase\endlink).
* @link Cantera::IdealSolidSolnPhase IdealSolidSolnPhase@endlink).
*
* This class inherits from the %Cantera class ThermoPhase and implements an
* ideal solid solution model with incompressible thermodynamics.
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/IdealSolnGasVPSS.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* an ideal solution approximation and handles
* variable pressure standard state methods for calculating
* thermodynamic properties (see @ref thermoprops and
* class \link Cantera::IdealSolnGasVPSS IdealSolnGasVPSS\endlink).
* class @link Cantera::IdealSolnGasVPSS IdealSolnGasVPSS@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/IonsFromNeutralVPSSTP.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @file IonsFromNeutralVPSSTP.h Header for intermediate ThermoPhase object for
* phases which consist of ions whose thermodynamics is calculated from
* neutral molecule thermodynamics. (see @ref thermoprops and class \link
* Cantera::IonsFromNeutralVPSSTP IonsFromNeutralVPSSTP\endlink).
* neutral molecule thermodynamics. (see @ref thermoprops and class @link
* Cantera::IonsFromNeutralVPSSTP IonsFromNeutralVPSSTP@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/LatticePhase.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @file LatticePhase.h Header for a simple thermodynamics model of a bulk
* phase derived from ThermoPhase, assuming a lattice of solid atoms (see
* @ref thermoprops and class \link Cantera::LatticePhase
* LatticePhase\endlink).
* @ref thermoprops and class @link Cantera::LatticePhase
* LatticePhase@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/LatticeSolidPhase.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @file LatticeSolidPhase.h Header for a simple thermodynamics model of a bulk
* solid phase derived from ThermoPhase, assuming an ideal solution model
* based on a lattice of solid atoms (see @ref thermoprops and class \link
* Cantera::LatticeSolidPhase LatticeSolidPhase\endlink).
* based on a lattice of solid atoms (see @ref thermoprops and class @link
* Cantera::LatticeSolidPhase LatticeSolidPhase@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/MargulesVPSSTP.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @file MargulesVPSSTP.h (see @ref thermoprops and class \link
* Cantera::MargulesVPSSTP MargulesVPSSTP\endlink).
* @file MargulesVPSSTP.h (see @ref thermoprops and class @link
* Cantera::MargulesVPSSTP MargulesVPSSTP@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/MixtureFugacityTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @file MixtureFugacityTP.h
* Header file for a derived class of ThermoPhase that handles
* non-ideal mixtures based on the fugacity models (see @ref thermoprops and
* class \link Cantera::MixtureFugacityTP MixtureFugacityTP\endlink).
* class @link Cantera::MixtureFugacityTP MixtureFugacityTP@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/MolalityVPSSTP.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Header for intermediate ThermoPhase object for phases which
* employ molality based activity coefficient formulations
* (see @ref thermoprops
* and class \link Cantera::MolalityVPSSTP MolalityVPSSTP\endlink).
* and class @link Cantera::MolalityVPSSTP MolalityVPSSTP@endlink).
*
* Header file for a derived class of ThermoPhase that handles
* variable pressure standard state methods for calculating
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/thermo/Mu0Poly.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* @file Mu0Poly.h
* Header for a single-species standard state object derived
* from \link Cantera::SpeciesThermoInterpType SpeciesThermoInterpType\endlink based
* from @link Cantera::SpeciesThermoInterpType SpeciesThermoInterpType@endlink based
* on a piecewise constant mu0 interpolation
* (see @ref spthermo and class \link Cantera::Mu0Poly Mu0Poly\endlink).
* (see @ref spthermo and class @link Cantera::Mu0Poly Mu0Poly@endlink).
*/

// This file is part of Cantera. See License.txt in the top-level directory or
Expand Down
Loading

0 comments on commit 5b07e7f

Please sign in to comment.