Skip to content

Commit

Permalink
[Doc] Clean up usage of @see directive
Browse files Browse the repository at this point in the history
  • Loading branch information
speth authored and ischoegl committed May 30, 2022
1 parent bbcdabe commit 05cb4e4
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 19 deletions.
6 changes: 3 additions & 3 deletions include/cantera/base/AnyMap.h
Expand Up @@ -261,10 +261,10 @@ class AnyValue : public AnyBase
//! Return values used to determine the sort order when outputting to YAML
std::pair <int, int> order() const;

//! @see AnyMap::applyUnits(const UnitSystem&)
//! See AnyMap::applyUnits()
void applyUnits(shared_ptr<UnitSystem>& units);

//! @see AnyMap::setFlowStyle
//! See AnyMap::setFlowStyle()
void setFlowStyle(bool flow=true);

private:
Expand Down Expand Up @@ -615,7 +615,7 @@ class AnyMap : public AnyBase
*/
void applyUnits();

//! @see applyUnits(const UnitSystem&)
//! See applyUnits()
void applyUnits(shared_ptr<UnitSystem>& units);

//! Set the unit system for this AnyMap. The applyUnits() method should be
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/base/YamlWriter.h
Expand Up @@ -75,10 +75,10 @@ class YamlWriter

std::vector<shared_ptr<Solution>> m_phases;

//! @see setPrecision()
//! See setPrecision()
long int m_float_precision;

//! @see skipUserDefined()
//! See skipUserDefined()
bool m_skip_user_defined;

//! Top-level units directive for the output file. Defaults to Cantera's
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/ctexceptions.h
Expand Up @@ -191,7 +191,7 @@ class NotImplementedError : public CanteraError
NotImplementedError(const std::string& func) :
CanteraError(func, "Not implemented.") {}

//! Alternative constructor taking same arguments as @see CanteraError
//! Alternative constructor taking same arguments as CanteraError
template <typename... Args>
NotImplementedError(const std::string& func, const std::string& msg,
const Args&... args) :
Expand Down
8 changes: 5 additions & 3 deletions include/cantera/base/global.h
Expand Up @@ -166,8 +166,9 @@ void writeline(char repeat, size_t count,
//! helper function passing deprecation warning to global handler
void _warn_deprecated(const std::string& method, const std::string& extra="");

//! Print a deprecation warning raised from *method*. @see Application::warn_deprecated
//! Print a deprecation warning raised from *method*.
/*!
* @see Application::warn_deprecated
* @param method method name
* @param msg Python-style format string with the following arguments
* @param args arguments for the format string
Expand All @@ -189,9 +190,10 @@ void suppress_deprecation_warnings();
void _warn(const std::string& warning,
const std::string& method, const std::string& extra);

//! Print a generic warning raised from *method*. @see Application::warn
//! Print a generic warning raised from *method*.
/*!
* @param warning type of warning; @see Logger::warn
* @see Application::warn
* @param warning type of warning; See Logger::warn
* @param method method name
* @param msg Python-style format string with the following arguments
* @param args arguments for the format string
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/logger.h
Expand Up @@ -70,7 +70,7 @@ class Logger
//! Write a warning message.
/*!
* The default behavior is to write to the logging output.
* @param warning String specifying type of warning; @see Logger::warn
* @param warning String specifying type of warning; See Logger::warn
* @param msg String message to be written to cout
*/
virtual void warn(const std::string& warning, const std::string& msg) {
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/equil/ChemEquil.h
Expand Up @@ -124,7 +124,7 @@ class ChemEquil

/**
* Options controlling how the calculation is carried out.
* @see EquilOptions
* @see EquilOpt
*/
EquilOpt options;

Expand Down
4 changes: 3 additions & 1 deletion include/cantera/kinetics/InterfaceRate.h
Expand Up @@ -188,7 +188,9 @@ class InterfaceRateBase
* \f[
* f_{BV} = \exp ( - \beta * Delta E_{p,j} / R T )
* \f]
* is applied to the forward reaction rate, @see voltageCorrection.
* is applied to the forward reaction rate.
*
* @see voltageCorrection().
*/
bool usesElectrochemistry() {
return m_chargeTransfer;
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/kinetics/Kinetics.h
Expand Up @@ -1363,10 +1363,10 @@ class Kinetics
//! Buffer used for storage of intermediate reaction-specific results
vector_fp m_rbuf;

//! @see skipUndeclaredSpecies()
//! See skipUndeclaredSpecies()
bool m_skipUndeclaredSpecies;

//! @see skipUndeclaredThirdBodies()
//! See skipUndeclaredThirdBodies()
bool m_skipUndeclaredThirdBodies;

//! reference to Solution
Expand Down
4 changes: 2 additions & 2 deletions include/cantera/numerics/CVodesIntegrator.h
Expand Up @@ -20,8 +20,8 @@ namespace Cantera
/**
* Wrapper class for 'cvodes' integrator from LLNL.
*
* @see FuncEval.h. Classes that use CVodesIntegrator:
* ImplicitChem, ImplicitSurfChem, Reactor
* See FuncEval.h. Classes that use CVodesIntegrator:
* ImplicitSurfChem, ReactorNet
*/
class CVodesIntegrator : public Integrator
{
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/transport/GasTransport.h
Expand Up @@ -48,7 +48,7 @@ class GasTransport : public Transport
*
* @returns the viscosity of the mixture (units = Pa s = kg /m /s)
*
* @see updateViscosity_T();
* @see updateViscosity_T()
*/
virtual doublereal viscosity();

Expand Down
4 changes: 2 additions & 2 deletions src/base/application.h
Expand Up @@ -137,7 +137,7 @@ class Application

//! Write a warning message to the screen.
/*!
* @param warning String specifying type of warning; @see Logger::warn
* @param warning String specifying type of warning; See Logger::warn
* @param msg String to be written to the screen
* @ingroup textlogs
*/
Expand Down Expand Up @@ -323,7 +323,7 @@ class Application
}

//! Generate a general purpose warning; repeated warnings are not suppressed
//! @param warning Warning type; @see Logger::warn
//! @param warning Warning type; See Logger::warn
//! @param method Name of method triggering the warning
//! @param extra Additional information printed for the warning
void warn(const std::string& warning,
Expand Down

0 comments on commit 05cb4e4

Please sign in to comment.