Skip to content

Commit

Permalink
[doxygen] Eliminate '///' in favor of '//!' commenting style
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl authored and speth committed May 24, 2022
1 parent 48457cc commit d17399f
Show file tree
Hide file tree
Showing 26 changed files with 208 additions and 208 deletions.
16 changes: 8 additions & 8 deletions include/cantera/base/Array.h
Expand Up @@ -184,42 +184,42 @@ class Array2D
return m_data[m_nrows*j + i];
}

/// Number of rows
//! Number of rows
size_t nRows() const {
return m_nrows;
}

/// Number of columns
//! Number of columns
size_t nColumns() const {
return m_ncols;
}

/// Return an iterator pointing to the first element
//! Return an iterator pointing to the first element
iterator begin() {
return m_data.begin();
}

/// Return an iterator pointing past the last element
//! Return an iterator pointing past the last element
iterator end() {
return m_data.end();
}

/// Return a const iterator pointing to the first element
//! Return a const iterator pointing to the first element
const_iterator begin() const {
return m_data.begin();
}

/// Return a const iterator pointing to past the last element
//! Return a const iterator pointing to past the last element
const_iterator end() const {
return m_data.end();
}

/// Return a reference to the data vector
//! Return a reference to the data vector
vector_fp& data() {
return m_data;
}

/// Return a const reference to the data vector
//! Return a const reference to the data vector
const vector_fp& data() const {
return m_data;
}
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/base/NoExitLogger.h
Expand Up @@ -10,8 +10,8 @@
#include "cantera/base/logger.h"

namespace Cantera {
/// Logger that doesn't exit when an error is thrown.
/// @ingroup textlogs
//! Logger that doesn't exit when an error is thrown.
//! @ingroup textlogs
class NoExitLogger : public Logger {
public:
NoExitLogger() {}
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/ct_defs.h
Expand Up @@ -73,7 +73,7 @@ const double Planck = 6.62607015e-34;
//! Elementary charge \f$ e \f$ [C]
const double ElectronCharge = 1.602176634e-19;

/// Speed of Light in a vacuum \f$ c \f$ [m/s]
//! Speed of Light in a vacuum \f$ c \f$ [m/s]
const double lightSpeed = 299792458.0;

//! One atmosphere [Pa]
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/base/global.h
Expand Up @@ -286,8 +286,8 @@ void setLogger(Logger* logwriter);
*/
doublereal toSI(const std::string& unit);

/// Return the conversion factor to convert activation energy unit
/// std::string 'unit' to Kelvin.
//! Return the conversion factor to convert activation energy unit
//! std::string 'unit' to Kelvin.
/*!
* @param unit String containing the activation energy units
* @deprecated To be removed after Cantera 2.6. Used only with XML input.
Expand Down
40 changes: 20 additions & 20 deletions include/cantera/base/logger.h
Expand Up @@ -17,26 +17,26 @@
namespace Cantera
{

/// Base class for 'loggers' that write text messages to log files.
///
/// This class is used to direct log messages to application- or environment-
/// specific output. The default is to simply print the messages to the standard
/// output stream or standard error stream, but classes may be derived from
/// Logger that implement other output options. This is important when Cantera
/// is used in applications that do not display the standard output, such as
/// MATLAB. The Cantera MATLAB interface derives a class from Logger that
/// implements these methods with MATLAB-specific procedures, insuring that the
/// messages will be passed through to the user. It would also be possible to
/// derive a class that displayed the messages in a pop-up window, or redirected
/// them to a file, etc.
///
/// To install a logger, call function setLogger (global.h / misc.cpp).
///
/// See the files Cantera/python/src/pylogger.h and
/// Cantera/matlab/cantera/private/mllogger.h for examples of
/// deriving logger classes.
/// @ingroup textlogs
///
//! Base class for 'loggers' that write text messages to log files.
//!
//! This class is used to direct log messages to application- or environment-
//! specific output. The default is to simply print the messages to the standard
//! output stream or standard error stream, but classes may be derived from
//! Logger that implement other output options. This is important when Cantera
//! is used in applications that do not display the standard output, such as
//! MATLAB. The Cantera MATLAB interface derives a class from Logger that
//! implements these methods with MATLAB-specific procedures, insuring that the
//! messages will be passed through to the user. It would also be possible to
//! derive a class that displayed the messages in a pop-up window, or redirected
//! them to a file, etc.
//!
//! To install a logger, call function setLogger (global.h / misc.cpp).
//!
//! See the files Cantera/python/src/pylogger.h and
//! Cantera/matlab/cantera/private/mllogger.h for examples of
//! deriving logger classes.
//! @ingroup textlogs
//!
class Logger
{
public:
Expand Down
10 changes: 5 additions & 5 deletions include/cantera/equil/ChemEquil.h
Expand Up @@ -16,7 +16,7 @@ namespace Cantera

class DenseMatrix;
class ThermoPhase;
/// map property strings to integers
//! map property strings to integers
int _equilflag(const char* xy);

/**
Expand All @@ -29,10 +29,10 @@ class EquilOpt
iterations(0),
maxStepSize(10.0), propertyPair(TP), contin(false) {}

doublereal relTolerance; ///< Relative tolerance
doublereal absElemTol; ///< Abs Tol in element number
int maxIterations; ///< Maximum number of iterations
int iterations; ///< Iteration counter
doublereal relTolerance; //! < Relative tolerance
doublereal absElemTol; //! < Abs Tol in element number
int maxIterations; //! < Maximum number of iterations
int iterations; //! < Iteration counter

/**
* Maximum step size. Largest change in any element potential or
Expand Down
26 changes: 13 additions & 13 deletions include/cantera/equil/MultiPhase.h
Expand Up @@ -151,7 +151,7 @@ class MultiPhase
*/
doublereal nAtoms(const size_t kGlob, const size_t mGlob) const;

/// Returns the global Species mole fractions.
//! Returns the global Species mole fractions.
/*!
* Write the array of species mole
* fractions into array \c x. The mole fractions are
Expand Down Expand Up @@ -195,7 +195,7 @@ class MultiPhase
*/
void setPhaseMoles(const size_t n, const doublereal moles);

/// Return a reference to phase n.
//! Return a reference to phase n.
/*!
* The state of phase n is also updated to match the state stored locally
* in the mixture object.
Expand Down Expand Up @@ -243,24 +243,24 @@ class MultiPhase
*/
size_t speciesIndex(const std::string& speciesName, const std::string& phaseName);

/// Minimum temperature for which all solution phases have valid thermo
/// data. Stoichiometric phases are not considered, since they may have
/// thermo data only valid for conditions for which they are stable.
//! Minimum temperature for which all solution phases have valid thermo
//! data. Stoichiometric phases are not considered, since they may have
//! thermo data only valid for conditions for which they are stable.
doublereal minTemp() const {
return m_Tmin;
}

/// Maximum temperature for which all solution phases have valid thermo
/// data. Stoichiometric phases are not considered, since they may have
/// thermo data only valid for conditions for which they are stable.
//! Maximum temperature for which all solution phases have valid thermo
//! data. Stoichiometric phases are not considered, since they may have
//! thermo data only valid for conditions for which they are stable.
doublereal maxTemp() const {
return m_Tmax;
}

//! Total charge summed over all phases (Coulombs).
doublereal charge() const;

/// Charge (Coulombs) of phase with index \a p.
//! Charge (Coulombs) of phase with index \a p.
/*!
* The net charge is computed as \f[ Q_p = N_p \sum_k F z_k X_k \f]
* where the sum runs only over species in phase \a p.
Expand Down Expand Up @@ -288,7 +288,7 @@ class MultiPhase
*/
void getChemPotentials(doublereal* mu) const;

/// Returns a vector of Valid chemical potentials.
//! Returns a vector of Valid chemical potentials.
/*!
* Write into array \a mu the chemical potentials of all species with
* thermo data valid for the current temperature [J/kmol]. For other
Expand Down Expand Up @@ -365,7 +365,7 @@ class MultiPhase
double rtol=1e-9, int max_steps=50000, int max_iter=100,
int estimate_equil=0, int log_level=0);

/// Set the temperature [K].
//! Set the temperature [K].
/*!
* @param T value of the temperature (Kelvin)
*/
Expand All @@ -387,12 +387,12 @@ class MultiPhase
*/
void setState_TPMoles(const doublereal T, const doublereal Pres, const doublereal* Moles);

/// Pressure [Pa].
//! Pressure [Pa].
doublereal pressure() const {
return m_press;
}

/// The total mixture volume [m^3].
//! The total mixture volume [m^3].
/*!
* Returns the cumulative sum of the volumes of all the phases in the
* mixture.
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/kinetics/Group.h
Expand Up @@ -109,15 +109,15 @@ class Group
return m_comp.size();
}

/// Number of atoms in the group (>= 0)
//! Number of atoms in the group (>= 0)
int nAtoms() const {
int sum = 0;
for (size_t m = 0; m < m_comp.size(); m++) {
sum += std::abs(m_comp[m]);
}
return sum;
}
/// Number of atoms of element m (positive or negative)
//! Number of atoms of element m (positive or negative)
int nAtoms(size_t m) const {
if (m_comp.empty()) {
return 0;
Expand Down

0 comments on commit d17399f

Please sign in to comment.