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 2015-05-26 17:05:40 -04:00
parent 8e2e4ae60b
commit 57e73dcb74
6 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/doxygen/Cantera.txt
View file

@ -3,7 +3,4 @@
Use the menu at the top to view detailed documentation of the code. Use the menu at the top to view detailed documentation of the code.
\ref thermopage
*/ */

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

@ -336,7 +336,7 @@ public:
* + ln(ActCoeff[i](VCS_DELETE_MINORSPECIES_CUTOFF)) * + ln(ActCoeff[i](VCS_DELETE_MINORSPECIES_CUTOFF))
* *
* @param[in] iph Phase to be calculated * @param[in] iph Phase to be calculated
* @param[in] molNum(i) Number of moles of species i (VCS species order) * @param[in] molNum Number of moles of species i (VCS species order)
* @param[out] ac Activity coefficients for species in phase (VCS * @param[out] ac Activity coefficients for species in phase (VCS
* species order) * species order)
* @param[out] mu_i Dimensionless chemical potentials for phase * @param[out] mu_i Dimensionless chemical potentials for phase

7
include/cantera/kinetics/GasKinetics.h
View file

@ -81,8 +81,11 @@ protected:
//! #m_falloff_low_rates and #m_falloff_high_rates) //! #m_falloff_low_rates and #m_falloff_high_rates)
std::map<size_t, size_t> m_rfallindx; std::map<size_t, size_t> m_rfallindx;
Rate1<Arrhenius> m_falloff_low_rates; //! Rate expressions for falloff reactions at the low-pressure limit
Rate1<Arrhenius> m_falloff_high_rates; Rate1<Arrhenius> m_falloff_low_rates;
//! Rate expressions for falloff reactions at the high-pressure limit
Rate1<Arrhenius> m_falloff_high_rates;
FalloffMgr m_falloffn; FalloffMgr m_falloffn;

2
include/cantera/kinetics/Reaction.h
View file

@ -249,7 +249,7 @@ public:
//! Create a new Reaction object for the reaction defined in `rxn_node` //! Create a new Reaction object for the reaction defined in `rxn_node`
shared_ptr<Reaction> newReaction(const XML_Node& rxn_node); shared_ptr<Reaction> newReaction(const XML_Node& rxn_node);
//! Create Reaction objects for all <reaction> nodes in an XML document. //! Create Reaction objects for all `<reaction>` nodes in an XML document.
//! //!
//! The `<reaction>` nodes are assumed to be children of the `<reactionData>` //! The `<reaction>` nodes are assumed to be children of the `<reactionData>`
//! node in an XML document with a `<ctml>` root node, as in the case of XML //! node in an XML document with a `<ctml>` root node, as in the case of XML

6
include/cantera/thermo/Species.h
View file

@ -53,10 +53,10 @@ public:
//! Create a new Species object from a 'species' XML_Node. //! Create a new Species object from a 'species' XML_Node.
shared_ptr<Species> newSpecies(const XML_Node& species_node); shared_ptr<Species> newSpecies(const XML_Node& species_node);
//! Generate Species objects for all <species> nodes in an XML document. //! Generate Species objects for all `<species>` nodes in an XML document.
//! //!
//! The <species> nodes are assumed to be children of the <speciesData> node in //! The `<species>` nodes are assumed to be children of the `<speciesData>` node
//! an XML document with a <ctml> root node, as in the case of XML files //! in an XML document with a `<ctml>` root node, as in the case of XML files
//! produced by conversion from CTI files. //! produced by conversion from CTI files.
//! //!
//! This function can be used in combination with get_XML_File and //! This function can be used in combination with get_XML_File and

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

@ -278,7 +278,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const std::string& type,
//! Create a new SpeciesThermoInterpType object from XML_Node //! Create a new SpeciesThermoInterpType object from XML_Node
/*! /*!
* @param thermo 'thermo' XML_Node (child of the 'species' node) with child * @param thermoNode 'thermo' XML_Node (child of the 'species' node) with child
* nodes representing parameterizations for one or more temperature ranges * nodes representing parameterizations for one or more temperature ranges
* @return Returns the pointer to the newly allocated * @return Returns the pointer to the newly allocated
* SpeciesThermoInterpType object * SpeciesThermoInterpType object