[Doc] Fix some style typos in the Doxygen docs

This commit is contained in:
Bryan W. Weber 2018-06-12 16:17:16 -04:00 committed by Ray Speth
parent dbc3df1687
commit 2f3a0122d6
3 changed files with 13 additions and 10 deletions

View file

@ -10,9 +10,11 @@ namespace Cantera
{
/**
* @defgroup falloffGroup Falloff Parameterizations This section describes the
* parameterizations used to describe the fall-off in reaction rate constants
* due to intermolecular energy transfer.
* @defgroup falloffGroup Falloff Parameterizations
*
* This section describes the parameterizations used to describe
* the fall-off in reaction rate constants due to intermolecular
* energy transfer.
* @ingroup chemkinetics
*/

View file

@ -22,18 +22,19 @@ class PDSS_Water;
/**
* @defgroup relatedProps Electric Properties of Phases
*
* ### Treatment of the %Phase Potential and the electrochemical potential of
* a species
* Computation of the electric properties of phases
*
* The electrochemical potential of species *k* in a phase *p*, \f$ \zeta_k \f$,
* ### Treatment of the phase potential and the electrochemical potential of a species
*
* The electrochemical potential of species \f$k\f$ in a phase \f$p\f$, \f$ \zeta_k \f$,
* is related to the chemical potential via the following equation,
*
* \f[
* \zeta_{k}(T,P) = \mu_{k}(T,P) + z_k \phi_p
* \f]
*
* where \f$ \nu_k \f$ is the charge of species *k*, and \f$ \phi_p \f$ is
* the electric potential of phase *p*.
* where \f$ \nu_k \f$ is the charge of species \f$k\f$, and \f$ \phi_p \f$ is
* the electric potential of phase \f$p\f$.
*
* The potential \f$ \phi_p \f$ is tracked and internally stored within the
* base ThermoPhase object. It constitutes a specification of the internal state

View file

@ -1,6 +1,6 @@
/**
* @file LTPspecies.cpp \
* definitions for the LTPspecies objects and its children, which is the virtual base class
* @file LTPspecies.cpp
* Definitions for the LTPspecies objects and its children, which is the virtual base class
* for describing temperature dependence of submodels for transport parameters
* (see \ref tranprops and \link Cantera::LTPspecies LTPspecies \endlink) .
*/