From e09db927568815dfd2fc4108a1bdcd4701e3d976 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Sat, 15 Nov 2014 00:47:19 +0000 Subject: [PATCH] [Doc] Fix some Doxygen warnings --- include/cantera/equil/MultiPhaseEquil.h | 2 ++ include/cantera/kinetics/RateCoeffMgr.h | 2 +- include/cantera/kinetics/Reaction.h | 2 +- include/cantera/thermo/MixtureFugacityTP.h | 7 ++----- include/cantera/thermo/Mu0Poly.h | 4 +--- include/cantera/thermo/PseudoBinaryVPSSTP.h | 5 ----- include/cantera/transport/Tortuosity.h | 4 ++-- src/thermo/SpeciesThermoFactory.cpp | 2 +- 8 files changed, 10 insertions(+), 18 deletions(-) diff --git a/include/cantera/equil/MultiPhaseEquil.h b/include/cantera/equil/MultiPhaseEquil.h index ce251f7b6..1ce7228ec 100644 --- a/include/cantera/equil/MultiPhaseEquil.h +++ b/include/cantera/equil/MultiPhaseEquil.h @@ -33,6 +33,8 @@ public: //! @param start If true, the initial composition will be determined by a //! linear Gibbs minimization, otherwise the initial mixture //! composition will be used. + //! @param loglevel Desired level of debug printing. loglevel = 0 suppresses + //! printing. Higher values request more verbose logging output. MultiPhaseEquil(MultiPhase* mix, bool start=true, int loglevel = 0); virtual ~MultiPhaseEquil() {} diff --git a/include/cantera/kinetics/RateCoeffMgr.h b/include/cantera/kinetics/RateCoeffMgr.h index 1dfeabfbf..2898ea98c 100644 --- a/include/cantera/kinetics/RateCoeffMgr.h +++ b/include/cantera/kinetics/RateCoeffMgr.h @@ -48,7 +48,7 @@ public: /** * Install a rate coefficient calculator. * @param rxnNumber the reaction number - * @param rdata rate coefficient specification for the reaction + * @param rate rate coefficient specification for the reaction */ void install(size_t rxnNumber, const R& rate) { m_rxn.push_back(rxnNumber); diff --git a/include/cantera/kinetics/Reaction.h b/include/cantera/kinetics/Reaction.h index 6d588c15c..38ba218e3 100644 --- a/include/cantera/kinetics/Reaction.h +++ b/include/cantera/kinetics/Reaction.h @@ -87,7 +87,7 @@ public: Composition efficiencies; //! The default third body efficiency for species not listed in - //! #third_body_efficiencies. + //! #efficiencies. double default_efficiency; }; diff --git a/include/cantera/thermo/MixtureFugacityTP.h b/include/cantera/thermo/MixtureFugacityTP.h index ce93348c5..a1345b597 100644 --- a/include/cantera/thermo/MixtureFugacityTP.h +++ b/include/cantera/thermo/MixtureFugacityTP.h @@ -750,11 +750,8 @@ public: public: //! Calculate the saturation pressure at the current mixture content for the given temperature /*! - * @param TKelvin (input) Temperature (Kelvin) - * @param molarVolGas (return) Molar volume of the gas - * @param molarVolLiquid (return) Molar volume of the liquid - * - * @return Returns the saturation pressure at the given temperature + * @param TKelvin Temperature (Kelvin) + * @return The saturation pressure at the given temperature */ virtual doublereal satPressure(doublereal TKelvin); diff --git a/include/cantera/thermo/Mu0Poly.h b/include/cantera/thermo/Mu0Poly.h index 1b57633ed..7690eab3d 100644 --- a/include/cantera/thermo/Mu0Poly.h +++ b/include/cantera/thermo/Mu0Poly.h @@ -213,9 +213,7 @@ private: * getting the information from an XML database. * * @param speciesName Name of the species - * @param sp Owning SpeciesThermo object - * @param k Species index - * @param Mu0Node_ptr Pointer to the XML element containing the + * @param Mu0Node Pointer to the XML element containing the * Mu0 information. * * @ingroup spthermo diff --git a/include/cantera/thermo/PseudoBinaryVPSSTP.h b/include/cantera/thermo/PseudoBinaryVPSSTP.h index b417556d1..37afe5bc0 100644 --- a/include/cantera/thermo/PseudoBinaryVPSSTP.h +++ b/include/cantera/thermo/PseudoBinaryVPSSTP.h @@ -179,11 +179,6 @@ public: */ void initThermoXML(XML_Node& phaseNode, const std::string& id); - //! returns a summary of the state of the phase as a string - /*! - * @param show_thermo If true, extra information is printed out - * about the thermodynamic state of the system. - */ virtual std::string report(bool show_thermo=true, doublereal threshold=1e-14) const; diff --git a/include/cantera/transport/Tortuosity.h b/include/cantera/transport/Tortuosity.h index 556e9c9a3..3b6c38cc7 100644 --- a/include/cantera/transport/Tortuosity.h +++ b/include/cantera/transport/Tortuosity.h @@ -1,5 +1,5 @@ /** - * @file TortuosityBruggeman.h + * @file Tortuosity.h * Class to compute the increase in diffusive path length in porous media * assuming the Bruggeman exponent relation */ @@ -182,7 +182,7 @@ public: protected: //! Relative conductivities of the dispersed and continuous phases, - //! \code{relativeConductivites_}\f$ = \kappa_d / \kappa_0 \f$. + //! `relativeConductivites_` \f$ = \kappa_d / \kappa_0 \f$. double relativeConductivites_; }; diff --git a/src/thermo/SpeciesThermoFactory.cpp b/src/thermo/SpeciesThermoFactory.cpp index 75550a674..758150ecb 100644 --- a/src/thermo/SpeciesThermoFactory.cpp +++ b/src/thermo/SpeciesThermoFactory.cpp @@ -322,7 +322,7 @@ static SpeciesThermoInterpType* newNasaThermoFromXML( /*! * This is called if a 'MinEQ3' node is found in the XML input. * - * @param speciesName name of the species + * @param name name of the species * @param MinEQ3node The XML_Node containing the MinEQ3 parameterization */ SpeciesThermoInterpType* newShomateForMineralEQ3(const std::string& name,