Skip to content

Commit

Permalink
[docs] Use at-sign for Doxygen cite command
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Jul 28, 2023
1 parent 4bb6a76 commit becbad1
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion include/cantera/kinetics/BlowersMaselRate.h
Expand Up @@ -40,7 +40,7 @@ struct BlowersMaselData : public ReactionData

//! Blowers Masel reaction rate type depends on the enthalpy of reaction
/**
* The Blowers Masel approximation \cite blowers2004 adjusts the activation energy
* The Blowers Masel approximation @cite blowers2004 adjusts the activation energy
* based on enthalpy change of a reaction:
*
* \f{eqnarray*}{
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/kinetics/Falloff.h
Expand Up @@ -508,9 +508,9 @@ class SriRate final : public FalloffRate
*
* References:
* * Example of reaction database developed by Tsang utilizing this format
* \cite tsang1991
* @cite tsang1991
* * Example of Chemkin implementation of Tsang format (supplemental materials)
* \cite lucassen2011
* @cite lucassen2011
*
* @ingroup falloffGroup
*/
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/InterfaceRate.h
Expand Up @@ -63,7 +63,7 @@ struct InterfaceData : public BlowersMaselData
//! Base class for rate parameterizations that involve interfaces
/**
* Rate expressions defined for interfaces may include coverage dependent terms,
* where an example is given by Kee, et al. \cite kee2003, Eq 11.113.
* where an example is given by Kee, et al. @cite kee2003, Eq 11.113.
* Using %Cantera nomenclature, this expression can be rewritten as
* \f[
* k_f = A T^b \exp \left( - \frac{E_a}{RT} \right)
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/PlasmaPhase.h
Expand Up @@ -45,7 +45,7 @@ namespace Cantera
* where \f$ i \f$ is the index of energy levels.
*
* For references, see Gudmundsson @cite gudmundsson2001; Khalilpour and Foroutan
* @cite khalilpour2020; and Hagelaar and Pitchford @cite hagelaar2005.
* @cite khalilpour2020; Hagelaar and Pitchford @cite hagelaar2005, and BOLOS
* @cite BOLOS.
*
* @warning This class is an experimental part of %Cantera and may be
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/thermo/WaterPropsIAPWSphi.h
Expand Up @@ -25,7 +25,7 @@ namespace Cantera
* and classes \link Cantera::WaterSSTP WaterSSTP\endlink and
* \link Cantera::PDSS_Water PDSS_Water\endlink).
*
* The reference is Wagner and Pruss \cite wagner2002.
* The reference is Wagner and Pruss @cite wagner2002.
*
* Units Note: This class works with reduced units exclusively.
*/
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/transport/GasTransport.h
Expand Up @@ -19,7 +19,7 @@ class MMCollisionInt;
//! Class GasTransport implements some functions and properties that are
//! shared by the MixTransport and MultiTransport classes.
//!
//! For details, see Kee, et al. \cite kee2003 and \cite kee2017.
//! For details, see Kee, et al. @cite kee2003 and @cite kee2017.
//!
//! @ingroup tranprops
class GasTransport : public Transport
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/transport/IonGasTransport.h
Expand Up @@ -27,7 +27,7 @@ namespace Cantera
* due to resonant charge transfer. Therefore, an experimental collision
* data is used instead.
*
* Data taken from \cite prager2005.
* Data taken from @cite prager2005.
*
* @ingroup tranprops
*/
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/transport/MixTransport.h
Expand Up @@ -19,7 +19,7 @@ namespace Cantera
//! Class MixTransport implements mixture-averaged transport properties for
//! ideal gas mixtures.
/*!
* The model is based on that described in Kee, et al. \cite kee2003.
* The model is based on that described in Kee, et al. @cite kee2003.
*
* The viscosity is computed using the Wilke mixture rule (kg /m /s)
*
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/transport/MultiTransport.h
Expand Up @@ -18,7 +18,7 @@ namespace Cantera
//! ideal gas mixtures.
/*!
* The implementation generally follows the procedure outlined in Kee, et al.
* \cite kee2003.
* @cite kee2003.
*
* @ingroup tranprops
*/
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/transport/WaterTransport.h
Expand Up @@ -40,7 +40,7 @@ class WaterTransport : public Transport
* This function calculates the value of the viscosity of pure water at the
* current T and P.
*
* The formulas used are from Sengers and Watson \cite sengers1986.
* The formulas used are from Sengers and Watson @cite sengers1986.
*
* The formulation is accurate for all temperatures and pressures, for steam
* and for water, even near the critical point. Pressures above 500 MPa and
Expand All @@ -58,7 +58,7 @@ class WaterTransport : public Transport
* This function calculates the value of the thermal conductivity of water
* at the current T and P.
*
* The formulas used are from Sengers and Watson \cite sengers1986.
* The formulas used are from Sengers and Watson @cite sengers1986.
*
* The formulation is accurate for all temperatures and pressures, for steam
* and for water, even near the critical point. Pressures above 500 MPa and
Expand Down

0 comments on commit becbad1

Please sign in to comment.