research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix some Doxygen warnings

Browse source
This commit is contained in:
Ray Speth 2016-07-07 23:37:03 -04:00
parent bd8a5d0bc9
commit 0d7cc10f99
12 changed files with 40 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/cantera/base/ctexceptions.h
View file

@ -67,7 +67,11 @@ public:
/*!
* @param procedure String name for the function within which the error was
* generated.
* @param msg Descriptive string describing the type of error message.
* @param msg Descriptive string describing the type of error message. This
* can be a fmt-style format string (i.e. using curly braces to indicate
* fields), which will be used with additional arguments to generate a
* formatted error message
* @param args Arguments which will be used to interpolate the format string
*/
template <typename... Args>
CanteraError(const std::string& procedure, const std::string& msg,
@ -255,8 +259,8 @@ public:
* @param expr Boolean expression that must be true
* @param procedure Character string or std:string expression indicating
* the procedure where the assertion failed
* @param message Character string or std:string expression containing
* a descriptive message is added to the thrown error condition.
* Additional arguments are passed on to the constructor for CanteraError to
* generate a formatted error message.
*
* @ingroup errorhandling
*/

11
include/cantera/base/global.h
View file

@ -160,10 +160,16 @@ inline void debuglog(const std::string& msg, int loglevel)
}
}
//! @copydoc Application::Messages::writelog(const std::string&)
//! Write a formatted message to the screen.
//!
//! This function passes its arguments to the fmt library 'format' function to
//! generate a formatted string from a Python-style (curly braces) format
//! string.
//! string. This method is used throughout Cantera to write log messages. It can
//! also be called by user programs. The advantage of using writelog over
//! writing directly to the standard output is that messages written with
//! writelog will display correctly even when Cantera is used from MATLAB or
//! other application that do not have a standard output stream.
//! @ingroup textlogs
template <typename... Args>
void writelog(const std::string& fmt, const Args&... args) {
if (sizeof...(args) == 0) {
@ -182,6 +188,7 @@ void writelog(const std::string& fmt, const Args&... args) {
* and then feed it into writelog().
*
* @param fmt c format string for the following arguments
* #param args arguments used to interpolate the format string
* @ingroup textlogs
*/
template <typename... Args>

16
include/cantera/equil/vcs_solve.h
View file

@ -147,13 +147,13 @@ public:
* Rearranges the solution data to put the component data at the
* front of the species list.
*
* Then, calculates m_stoichCoeffRxnMatrix(jcomp,irxn) the formation
* Then, calculates `m_stoichCoeffRxnMatrix(jcomp,irxn)` the formation
* reactions for all noncomponent species in the mechanism. Also
* calculates DNG(I) and DNL(I), the net mole change for each formation
* reaction. Also, initializes IR(I) to the default state.
*
* @param[in] doJustComponents If true, the m_stoichCoeffRxnMatrix and
* m_deltaMolNumPhase are not calculated.
* @param[in] doJustComponents If true, the #m_stoichCoeffRxnMatrix and
* #m_deltaMolNumPhase are not calculated.
* @param[in] aw Vector of mole fractions which will be used to
* construct an optimal basis from.
* @param[in] sa Gram-Schmidt orthog work space (nc in length) sa[j]
@ -175,13 +175,13 @@ public:
* calculates the #m_numComponents species. It switches their positions
* in the species vector so that they occupy the first #m_numComponents
* spots in the species vector.
* - #m_stoichCoeffRxnMatrix(jcomp,irxn) Stoichiometric coefficient
* - `m_stoichCoeffRxnMatrix(jcomp,irxn)` Stoichiometric coefficient
* matrix for the reaction mechanism expressed in Reduced Canonical
* Form. jcomp refers to the component number, and irxn refers to the
* irxn_th non-component species.
* - #m_deltaMolNumPhase(iphase,irxn): Change in the number of moles in
* - `m_deltaMolNumPhase(iphase,irxn)`: Change in the number of moles in
* phase, iphase, due to the noncomponent formation reaction, irxn.
* - #m_phaseParticipation(iphase,irxn): This is 1 if the phase, iphase,
* - `m_phaseParticipation(iphase,irxn)`: This is 1 if the phase, iphase,
* participates in the formation reaction, irxn, and zero otherwise.
*/
int vcs_basopt(const bool doJustComponents, double aw[], double sa[], double sm[],
@ -518,7 +518,7 @@ public:
/*!
* Formation reactions are
* reactions which create each noncomponent species from the component
* species. m_stoichCoeffRxnMatrix(jcomp,irxn) are the stoichiometric
* species. `m_stoichCoeffRxnMatrix(jcomp,irxn)` are the stoichiometric
* coefficients for these reactions. A stoichiometric coefficient of
* one is assumed for species irxn in this reaction.
*
@ -1427,7 +1427,7 @@ public:
*
* NOTE: kspec = irxn + m_numComponents
*
* m_stoichCoeffRxnMatrix(j,irxn) : j refers to the component number, and
* `m_stoichCoeffRxnMatrix(j,irxn)` : j refers to the component number, and
* irxn refers to the irxn_th non-component species. The stoichiometric
* coefficients multiplied by the Formula coefficients of the component
* species add up to the negative value of the number of elements in the

6
include/cantera/oneD/Sim1D.h
View file

@ -43,10 +43,10 @@ public:
/// Set initial guess for one component for all domains
/**
* @param comp component name
* @param pos A vector of relative positions, beginning with 0.0 at the
* @param component component name
* @param locs A vector of relative positions, beginning with 0.0 at the
* left of the domain, and ending with 1.0 at the right of the domain.
* @param values A vector of values corresponding to the relative position
* @param vals A vector of values corresponding to the relative position
* locations.
*/
void setInitialGuess(const std::string& component, vector_fp& locs,

1
include/cantera/thermo/AdsorbateThermo.h
View file

@ -40,6 +40,7 @@ public:
* @param tlow output - Minimum temperature
* @param thigh output - Maximum temperature
* @param pref output - reference pressure (Pa).
* @param coeffs Coefficients for the parameterization
*/
Adsorbate(double tlow, double thigh, double pref, const double* coeffs)
: SpeciesThermoInterpType(tlow, thigh, pref)

4
include/cantera/thermo/HMWSoln.h
View file

@ -1186,7 +1186,7 @@ public:
* @param id Optional parameter identifying the name of the
* phase. If none is given, the first XML
* phase element will be used.
* @deprecated Use #initThermoFile instead. To be removed after Cantera 2.3.
* @deprecated Use initThermoFile() instead. To be removed after Cantera 2.3.
*/
void constructPhaseFile(std::string inputFile, std::string id);
@ -1208,7 +1208,7 @@ public:
* describe the species in the phase.
* @param id ID of the phase. If nonnull, a check is done to see if
* phaseNode is pointing to the phase with the correct id.
* @deprecated Use #importPhase instead. To be removed after Cantera 2.3.
* @deprecated Use importPhase() instead. To be removed after Cantera 2.3.
*/
void constructPhaseXML(XML_Node& phaseNode, std::string id);

4
include/cantera/thermo/IonsFromNeutralVPSSTP.h
View file

@ -126,7 +126,7 @@ public:
* @param inputFile XML file containing the description of the phase
* @param id Optional parameter identifying the name of the phase. If none
* is given, the first XML phase element will be used.
* @deprecated Use #initThermoFile instead. To be removed after Cantera 2.3.
* @deprecated Use initThermoFile() instead. To be removed after Cantera 2.3.
*/
void constructPhaseFile(std::string inputFile, std::string id);
@ -148,7 +148,7 @@ public:
* describe the species in the phase.
* @param id ID of the phase. If nonnull, a check is done to see if
* phaseNode is pointing to the phase with the correct id.
* @deprecated Use #importPhase instead. To be removed after Cantera 2.3.
* @deprecated Use importPhase() instead. To be removed after Cantera 2.3.
*/
void constructPhaseXML(XML_Node& phaseNode, std::string id);

4
include/cantera/thermo/MultiSpeciesThermo.h
View file

@ -66,7 +66,7 @@ public:
* This will set up the thermo for one species
*/
virtual void install_STIT(size_t index,
shared_ptr<SpeciesThermoInterpType> stit_ptr);
shared_ptr<SpeciesThermoInterpType> stit);
//! Modify the species thermodynamic property parameterization for a species
/*!
@ -74,7 +74,7 @@ public:
* @param spec Pointer to the SpeciesThermoInterpType object
*/
virtual void modifySpecies(size_t index,
shared_ptr<SpeciesThermoInterpType> stit_ptr);
shared_ptr<SpeciesThermoInterpType> spec);
//! Install a PDSS object to handle the reference state thermodynamics
//! calculation

2
include/cantera/thermo/ThermoFactory.h
View file

@ -201,8 +201,6 @@ ThermoPhase* newPhase(const std::string& infile, std::string id="");
* thermodynamics for this phase. We initialize part of the
* ThermoPhase object here, especially for those objects which are
* part of the Cantera Kernel.
* @param spfactory species Thermo factory pointer, if available. If not
* available, one will be created.
* @ingroup thermoprops
*/
void importPhase(XML_Node& phase, ThermoPhase* th);

2
include/cantera/thermo/VPSSMgr_General.h
View file

@ -75,7 +75,7 @@ protected:
* The following methods are used in the process of constructing the phase
* and setting its parameters from a specification in an input file. They
* are not normally used in application programs. To see how they are
* used, see #importPhase.
* used, see importPhase().
*/
//@{
virtual void initThermo();

1
include/cantera/zeroD/ReactorNet.h
View file

@ -182,6 +182,7 @@ public:
//! Used by Reactor and Wall objects to register the addition of
//! sensitivity parameters so that the ReactorNet can keep track of the
//! order in which sensitivity parameters are added.
//! @param name A name describing the parameter, e.g. the reaction string
//! @param value The nominal value of the parameter
//! @param scale A scaling factor to be applied to the sensitivity
//! coefficient

5
src/base/xml.cpp
View file

@ -29,6 +29,7 @@ protected:
* Note, we don't actually post the error in this class. Therefore, this
* class can't be used externally. Therefore, it's a protected constructor.
*
* @param file Name of the XML file being processed
* @param line Number number where the error occurred.
*/
XML_Error(const std::string& file, int line) {
@ -60,6 +61,7 @@ public:
*
* @param opentag String representing the opening of the XML bracket
* @param closetag String representing the closing of the XML bracket
* @param filename Name of the XML file being processed
* @param line Line number where the error occurred.
*/
XML_TagMismatch(const std::string& opentag, const std::string& closetag,
@ -85,8 +87,9 @@ public:
* An XML element doesn't have the required child node
*
* @param p XML_Node to write a string error message
* @param parent Namf of the parent node
* @param parent Name of the parent node
* @param child Name of the required child node
* @param filename Name of the XML file being processed
* @param line Line number where the error occurred.
*/
XML_NoChild(const XML_Node* p, const std::string& parent,