From 57e73dcb74a9e9ea05fb42e94724fcaec09df4ed Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 26 May 2015 17:05:40 -0400 Subject: [PATCH] [Doc] Fix some Doxygen warnings --- doc/doxygen/Cantera.txt | 3 --- include/cantera/equil/vcs_solve.h | 2 +- include/cantera/kinetics/GasKinetics.h | 7 +++++-- include/cantera/kinetics/Reaction.h | 2 +- include/cantera/thermo/Species.h | 6 +++--- include/cantera/thermo/SpeciesThermoFactory.h | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/doxygen/Cantera.txt b/doc/doxygen/Cantera.txt index 847b6128a..63c13a8f8 100644 --- a/doc/doxygen/Cantera.txt +++ b/doc/doxygen/Cantera.txt @@ -3,7 +3,4 @@ Use the menu at the top to view detailed documentation of the code. -\ref thermopage - - */ diff --git a/include/cantera/equil/vcs_solve.h b/include/cantera/equil/vcs_solve.h index 7f8323504..27380aa16 100644 --- a/include/cantera/equil/vcs_solve.h +++ b/include/cantera/equil/vcs_solve.h @@ -336,7 +336,7 @@ public: * + ln(ActCoeff[i](VCS_DELETE_MINORSPECIES_CUTOFF)) * * @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 * species order) * @param[out] mu_i Dimensionless chemical potentials for phase diff --git a/include/cantera/kinetics/GasKinetics.h b/include/cantera/kinetics/GasKinetics.h index 271baafc9..e00fe16d8 100644 --- a/include/cantera/kinetics/GasKinetics.h +++ b/include/cantera/kinetics/GasKinetics.h @@ -81,8 +81,11 @@ protected: //! #m_falloff_low_rates and #m_falloff_high_rates) std::map m_rfallindx; - Rate1 m_falloff_low_rates; - Rate1 m_falloff_high_rates; + //! Rate expressions for falloff reactions at the low-pressure limit + Rate1 m_falloff_low_rates; + + //! Rate expressions for falloff reactions at the high-pressure limit + Rate1 m_falloff_high_rates; FalloffMgr m_falloffn; diff --git a/include/cantera/kinetics/Reaction.h b/include/cantera/kinetics/Reaction.h index a0960805b..c70457026 100644 --- a/include/cantera/kinetics/Reaction.h +++ b/include/cantera/kinetics/Reaction.h @@ -249,7 +249,7 @@ public: //! Create a new Reaction object for the reaction defined in `rxn_node` shared_ptr newReaction(const XML_Node& rxn_node); -//! Create Reaction objects for all nodes in an XML document. +//! Create Reaction objects for all `` nodes in an XML document. //! //! The `` nodes are assumed to be children of the `` //! node in an XML document with a `` root node, as in the case of XML diff --git a/include/cantera/thermo/Species.h b/include/cantera/thermo/Species.h index f2d53c1b3..4989d9fa4 100644 --- a/include/cantera/thermo/Species.h +++ b/include/cantera/thermo/Species.h @@ -53,10 +53,10 @@ public: //! Create a new Species object from a 'species' XML_Node. shared_ptr newSpecies(const XML_Node& species_node); -//! Generate Species objects for all nodes in an XML document. +//! Generate Species objects for all `` nodes in an XML document. //! -//! The nodes are assumed to be children of the node in -//! an XML document with a root node, as in the case of XML files +//! The `` nodes are assumed to be children of the `` node +//! in an XML document with a `` root node, as in the case of XML files //! produced by conversion from CTI files. //! //! This function can be used in combination with get_XML_File and diff --git a/include/cantera/thermo/SpeciesThermoFactory.h b/include/cantera/thermo/SpeciesThermoFactory.h index 2755cdd42..b376404a8 100644 --- a/include/cantera/thermo/SpeciesThermoFactory.h +++ b/include/cantera/thermo/SpeciesThermoFactory.h @@ -278,7 +278,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const std::string& type, //! 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 * @return Returns the pointer to the newly allocated * SpeciesThermoInterpType object