From 336271c39509713bd1db106374fa6eed9e5af328 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Mon, 18 Apr 2016 14:58:15 -0400 Subject: [PATCH] [Doc] Clean up redundant "@return returns ..." --- include/cantera/base/stringUtils.h | 6 +++--- include/cantera/base/xml.h | 12 +++--------- include/cantera/equil/MultiPhase.h | 2 +- include/cantera/equil/vcs_VolPhase.h | 2 +- include/cantera/equil/vcs_internal.h | 2 +- include/cantera/equil/vcs_solve.h | 4 ++-- include/cantera/kinetics/Falloff.h | 2 +- include/cantera/kinetics/FalloffFactory.h | 2 +- include/cantera/kinetics/solveSP.h | 6 +++--- include/cantera/numerics/BandMatrix.h | 2 +- include/cantera/numerics/ResidJacEval.h | 2 +- include/cantera/thermo/LatticePhase.h | 2 +- include/cantera/thermo/MixtureFugacityTP.h | 2 +- include/cantera/thermo/MolalityVPSSTP.h | 2 +- include/cantera/thermo/PDSS_HKFT.h | 2 +- include/cantera/thermo/SpeciesThermoFactory.h | 9 +++------ include/cantera/thermo/ThermoPhase.h | 2 +- include/cantera/thermo/VPSSMgr_ConstVol.h | 4 ++-- include/cantera/thermo/VPSSMgr_General.h | 4 ++-- include/cantera/thermo/VPSSMgr_IdealGas.h | 4 ++-- include/cantera/thermo/VPStandardStateTP.h | 2 +- include/cantera/thermo/WaterProps.h | 4 ++-- include/cantera/transport/LTPspecies.h | 2 +- include/cantera/transport/MixTransport.h | 2 +- include/cantera/transport/SimpleTransport.h | 2 +- include/cantera/transport/TransportBase.h | 2 +- src/base/stringUtils.cpp | 4 ++-- src/thermo/VPSSMgrFactory.h | 3 +-- 28 files changed, 42 insertions(+), 52 deletions(-) diff --git a/include/cantera/base/stringUtils.h b/include/cantera/base/stringUtils.h index e086f8247..a86324352 100644 --- a/include/cantera/base/stringUtils.h +++ b/include/cantera/base/stringUtils.h @@ -102,7 +102,7 @@ compositionMap parseCompString(const std::string& ss, * used. * * @param val String value of the integer - * @return Returns an integer + * @returns an integer */ int intValue(const std::string& val); @@ -111,7 +111,7 @@ int intValue(const std::string& val); * No error checking is done on the conversion. * * @param val String value of the double - * @return Returns a doublereal value + * @returns a double */ doublereal fpValue(const std::string& val); @@ -134,7 +134,7 @@ doublereal fpValue(const std::string& val); * It always use the C locale, regardless of any locale settings. * * @param val String representation of the number - * @return Returns a doublereal value + * @returns a double */ doublereal fpValueCheck(const std::string& val); diff --git a/include/cantera/base/xml.h b/include/cantera/base/xml.h index f0636ac1d..b28918067 100644 --- a/include/cantera/base/xml.h +++ b/include/cantera/base/xml.h @@ -326,9 +326,6 @@ private: public: //! Returns an unchangeable value of the attributes map for the current node - /*! - * @return Returns an unchangeable reference to the attributes map - */ const std::map& attribsConst() const; //! Set the line number @@ -338,9 +335,6 @@ public: void setLineNumber(const int n); //! Return the line number - /*! - * @return returns the member data m_linenum - */ int lineNumber() const; //! Returns a pointer to the parent node of the current node @@ -349,21 +343,21 @@ public: //! Sets the pointer for the parent node of the current node /*! * @param p Pointer to the parent node - * @return Returns the pointer p + * @returns the pointer p */ XML_Node* setParent(XML_Node* const p); //! Tests whether the current node has a child node with a particular name /*! * @param ch Name of the child node to test - * @return Returns true if the child node exists, false otherwise. + * @returns true if the child node exists, false otherwise. */ bool hasChild(const std::string& ch) const; //! Tests whether the current node has an attribute with a particular name /*! * @param a Name of the attribute to test - * @return Returns true if the attribute exists, false otherwise. + * @returns true if the attribute exists, false otherwise. */ bool hasAttrib(const std::string& a) const; diff --git a/include/cantera/equil/MultiPhase.h b/include/cantera/equil/MultiPhase.h index 5276c45ee..93456f753 100644 --- a/include/cantera/equil/MultiPhase.h +++ b/include/cantera/equil/MultiPhase.h @@ -666,7 +666,7 @@ private: * * @param s ostream * @param x Reference to a MultiPhase - * @return returns a reference to the ostream + * @returns a reference to the ostream */ inline std::ostream& operator<<(std::ostream& s, MultiPhase& x) { diff --git a/include/cantera/equil/vcs_VolPhase.h b/include/cantera/equil/vcs_VolPhase.h index 371475b4e..d21a26aab 100644 --- a/include/cantera/equil/vcs_VolPhase.h +++ b/include/cantera/equil/vcs_VolPhase.h @@ -208,7 +208,7 @@ public: //! of a species, return a value for one species /*! * @param kspec species index - * @return return value of the Gibbs free energy + * @returns value of the Gibbs free energy */ double G0_calc_one(size_t kspec) const; diff --git a/include/cantera/equil/vcs_internal.h b/include/cantera/equil/vcs_internal.h index 88a42d836..17c22819a 100644 --- a/include/cantera/equil/vcs_internal.h +++ b/include/cantera/equil/vcs_internal.h @@ -97,7 +97,7 @@ typedef double(*VCS_FUNC_PTR)(double xval, double Vtarget, //! determine the l2 norm of a vector of doubles /*! * @param vec vector of doubles - * @return Returns the l2 norm of the vector + * @returns the l2 norm of the vector */ double vcs_l2norm(const vector_fp& vec); diff --git a/include/cantera/equil/vcs_solve.h b/include/cantera/equil/vcs_solve.h index 73e368d62..438a5e6a6 100644 --- a/include/cantera/equil/vcs_solve.h +++ b/include/cantera/equil/vcs_solve.h @@ -650,7 +650,7 @@ public: * @param maxit Maximum number of iterations for the algorithm * @param T Value of the Temperature (Kelvin) * @param pres Value of the Pressure - * @return Returns an integer representing the success of the algorithm + * @returns an integer representing the success of the algorithm * * 0 = Equilibrium Achieved * * 1 = Range space error encountered. The element abundance criteria are * only partially satisfied. Specifically, the first NC= (number of @@ -1183,7 +1183,7 @@ private: * phases. It's an overkill for single species phases. * * @param iphase Phase index number - * @return Returns true if the phase is currently deleted but should be + * @returns true if the phase is currently deleted but should be * reinstated. Returns false otherwise. * * NOTE: this routine is currently not used in the code, and diff --git a/include/cantera/kinetics/Falloff.h b/include/cantera/kinetics/Falloff.h index 566b505e2..888d2cf93 100644 --- a/include/cantera/kinetics/Falloff.h +++ b/include/cantera/kinetics/Falloff.h @@ -58,7 +58,7 @@ public: * @param work array of size workSize() containing cached * temperature-dependent intermediate results from a prior call * to updateTemp. - * @return Returns the value of the falloff function \f$ F \f$ defined above + * @returns the value of the falloff function \f$ F \f$ defined above */ virtual doublereal F(doublereal pr, const doublereal* work) const { return 1.0; diff --git a/include/cantera/kinetics/FalloffFactory.h b/include/cantera/kinetics/FalloffFactory.h index 6fba790ba..d9a91290e 100644 --- a/include/cantera/kinetics/FalloffFactory.h +++ b/include/cantera/kinetics/FalloffFactory.h @@ -55,7 +55,7 @@ public: * types as well. * @param c input vector of doubles which populates the falloff * parameterization. - * @return Returns a pointer to a new Falloff class. + * @returns a pointer to a new Falloff class. */ virtual Falloff* newFalloff(int type, const vector_fp& c); diff --git a/include/cantera/kinetics/solveSP.h b/include/cantera/kinetics/solveSP.h index 692141b39..9870f2857 100644 --- a/include/cantera/kinetics/solveSP.h +++ b/include/cantera/kinetics/solveSP.h @@ -180,8 +180,8 @@ public: * @param PGas Pressure (pascals) * @param reltol Relative tolerance to use * @param abstol absolute tolerance. - * @return Returns 1 if the surface problem is successfully solved. - * Returns -1 if the surface problem wasn't solved successfully. + * @return 1 if the surface problem is successfully solved. + * -1 if the surface problem wasn't solved successfully. * Note the actual converged solution is returned as part of the * internal state of the InterfaceKinetics objects. */ @@ -225,7 +225,7 @@ private: * that is used to indicate the same species is controlling the time * step. * @param ioflag Level of the output requested. - * @return Returns the 1. / delta T to be used on the next step + * @returns the 1. / delta T to be used on the next step */ doublereal calc_t(doublereal netProdRateSolnSP[], doublereal XMolSolnSP[], int* label, int* label_old, diff --git a/include/cantera/numerics/BandMatrix.h b/include/cantera/numerics/BandMatrix.h index 9cf72c2f0..1db00b632 100644 --- a/include/cantera/numerics/BandMatrix.h +++ b/include/cantera/numerics/BandMatrix.h @@ -149,7 +149,7 @@ public: /*! * The factorization is saved in ludata. * - * @return Return a success flag. 0 indicates a success; ~0 indicates some + * @returns a success flag. 0 indicates a success; ~0 indicates some * error occurred, see the LAPACK documentation */ int factor(); diff --git a/include/cantera/numerics/ResidJacEval.h b/include/cantera/numerics/ResidJacEval.h index 4bbf1450b..e78a4cb7a 100644 --- a/include/cantera/numerics/ResidJacEval.h +++ b/include/cantera/numerics/ResidJacEval.h @@ -113,7 +113,7 @@ public: * @param t Time (input) * @param ybase Solution vector (input, output) * @param step Proposed step in the solution that will be cropped - * @return Return the norm of the amount of filtering + * @returns the norm of the amount of filtering */ virtual doublereal filterNewStep(const doublereal t, const doublereal* const ybase, doublereal* const step); diff --git a/include/cantera/thermo/LatticePhase.h b/include/cantera/thermo/LatticePhase.h index 946406f7b..18c5f4235 100644 --- a/include/cantera/thermo/LatticePhase.h +++ b/include/cantera/thermo/LatticePhase.h @@ -397,7 +397,7 @@ public: * * @param k Optional parameter indicating the species. The default is to * assume this refers to species 0. - * @return Returns the standard Concentration in units of m^3/kmol. + * @returns the standard Concentration in units of m^3/kmol. * * @param k Species index */ diff --git a/include/cantera/thermo/MixtureFugacityTP.h b/include/cantera/thermo/MixtureFugacityTP.h index 627f19af3..6f2278b2b 100644 --- a/include/cantera/thermo/MixtureFugacityTP.h +++ b/include/cantera/thermo/MixtureFugacityTP.h @@ -302,7 +302,7 @@ public: * The pressure is an independent variable in this phase. Its current value * is stored in the object MixtureFugacityTP. * - * @return return the pressure in pascals. + * @returns the pressure in pascals. */ virtual doublereal pressure() const { return m_Pcurrent; diff --git a/include/cantera/thermo/MolalityVPSSTP.h b/include/cantera/thermo/MolalityVPSSTP.h index bb290d09e..5281d9976 100644 --- a/include/cantera/thermo/MolalityVPSSTP.h +++ b/include/cantera/thermo/MolalityVPSSTP.h @@ -215,7 +215,7 @@ public: * Single ion activity coefficients are not unique in terms of the * representing actual measurable quantities. * - * @return Return the pHscale type + * @returns the pHscale type */ int pHScale() const; diff --git a/include/cantera/thermo/PDSS_HKFT.h b/include/cantera/thermo/PDSS_HKFT.h index b4da91280..b90e1f133 100644 --- a/include/cantera/thermo/PDSS_HKFT.h +++ b/include/cantera/thermo/PDSS_HKFT.h @@ -93,7 +93,7 @@ public: * * Note this is just an extra routine to check the arithmetic * - * @return returns the species standard state enthalpy in J kmol-1 + * @returns the species standard state enthalpy in J kmol-1 */ doublereal enthalpy_mole2() const; diff --git a/include/cantera/thermo/SpeciesThermoFactory.h b/include/cantera/thermo/SpeciesThermoFactory.h index af245cda9..e08f9c297 100644 --- a/include/cantera/thermo/SpeciesThermoFactory.h +++ b/include/cantera/thermo/SpeciesThermoFactory.h @@ -23,8 +23,7 @@ class XML_Node; * @param thigh The highest temperature at which the parameterization is valid * @param pref The reference pressure for the parameterization * @param coeffs The array of coefficients for the parameterization - * @return Returns the pointer to the newly allocated - * SpeciesThermoInterpType object + * @returns The pointer to the newly allocated SpeciesThermoInterpType object */ SpeciesThermoInterpType* newSpeciesThermoInterpType(int type, double tlow, double thigh, double pref, const double* coeffs); @@ -36,8 +35,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(int type, double tlow, * @param thigh The highest temperature at which the parameterization is valid * @param pref The reference pressure for the parameterization * @param coeffs The array of coefficients for the parameterization - * @return Returns the pointer to the newly allocated - * SpeciesThermoInterpType object + * @returns the pointer to the newly allocated SpeciesThermoInterpType object */ SpeciesThermoInterpType* newSpeciesThermoInterpType(const std::string& type, double tlow, double thigh, double pref, const double* coeffs); @@ -46,8 +44,7 @@ SpeciesThermoInterpType* newSpeciesThermoInterpType(const std::string& type, /*! * @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 + * @returns the pointer to the newly allocated SpeciesThermoInterpType object */ SpeciesThermoInterpType* newSpeciesThermoInterpType(const XML_Node& thermoNode); diff --git a/include/cantera/thermo/ThermoPhase.h b/include/cantera/thermo/ThermoPhase.h index d77c77806..f0f22f2d6 100644 --- a/include/cantera/thermo/ThermoPhase.h +++ b/include/cantera/thermo/ThermoPhase.h @@ -155,7 +155,7 @@ public: * standard states at 298 K and 1 bar. * * @param k species index - * @return Returns the current value of the Heat of Formation at 298K + * @returns the current value of the Heat of Formation at 298K * and 1 bar */ doublereal Hf298SS(const int k) const { diff --git a/include/cantera/thermo/VPSSMgr_ConstVol.h b/include/cantera/thermo/VPSSMgr_ConstVol.h index f484d7583..cfd308368 100644 --- a/include/cantera/thermo/VPSSMgr_ConstVol.h +++ b/include/cantera/thermo/VPSSMgr_ConstVol.h @@ -97,8 +97,8 @@ public: * @param k Species index within the phase * @param speciesNode Reference to the species node in the XML tree * @param phaseNode_ptr Pointer to the phase node in the XML tree - * @return Returns a pointer to the a newly created PDSS object - * containing the parameterization + * @return A pointer to the a newly created PDSS object containing the + * parameterization */ virtual PDSS* createInstallPDSS(size_t k, const XML_Node& speciesNode, const XML_Node* const phaseNode_ptr); diff --git a/include/cantera/thermo/VPSSMgr_General.h b/include/cantera/thermo/VPSSMgr_General.h index 14e5f7932..da6468c1a 100644 --- a/include/cantera/thermo/VPSSMgr_General.h +++ b/include/cantera/thermo/VPSSMgr_General.h @@ -98,7 +98,7 @@ private: * instantiation has resulted in a SpeciesThermo object * being created and registered with the SpeciesThermo * manager class. - * @return Returns the pointer to a newly created PDSS object + * @returns the pointer to a newly created PDSS object */ PDSS* returnPDSS_ptr(size_t k, const XML_Node& speciesNode, const XML_Node* const phaseNode_ptr, bool& doST); @@ -118,7 +118,7 @@ public: * @param k Species number * @param speciesNode XML node for the standard state of the species * @param phaseNode_ptr pointer to the phase XML node - * @return Returns the pointer to the newly created PDSS object + * @return the pointer to the newly created PDSS object */ virtual PDSS* createInstallPDSS(size_t k, const XML_Node& speciesNode, const XML_Node* const phaseNode_ptr); diff --git a/include/cantera/thermo/VPSSMgr_IdealGas.h b/include/cantera/thermo/VPSSMgr_IdealGas.h index 9ade2767d..90226cba3 100644 --- a/include/cantera/thermo/VPSSMgr_IdealGas.h +++ b/include/cantera/thermo/VPSSMgr_IdealGas.h @@ -64,8 +64,8 @@ public: * @param k Species index within the phase * @param speciesNode Reference to the species node in the XML tree * @param phaseNode_ptr Pointer to the phase node in the XML tree - * @return Returns a pointer to the a newly created PDSS object - * containing the parameterization + * @return a pointer to the a newly created PDSS object containing the + * parameterization */ virtual PDSS* createInstallPDSS(size_t k, const XML_Node& speciesNode, const XML_Node* const phaseNode_ptr); diff --git a/include/cantera/thermo/VPStandardStateTP.h b/include/cantera/thermo/VPStandardStateTP.h index 4d21a83cf..9e1c0b1c1 100644 --- a/include/cantera/thermo/VPStandardStateTP.h +++ b/include/cantera/thermo/VPStandardStateTP.h @@ -140,7 +140,7 @@ public: * The pressure is an independent variable in this phase. Its current value * is stored in the object VPStandardStateTP. * - * @return return the pressure in pascals. + * @returns the pressure in pascals. */ virtual doublereal pressure() const { return m_Pcurrent; diff --git a/include/cantera/thermo/WaterProps.h b/include/cantera/thermo/WaterProps.h index 4cb1a340c..2ca03f56c 100644 --- a/include/cantera/thermo/WaterProps.h +++ b/include/cantera/thermo/WaterProps.h @@ -185,7 +185,7 @@ public: * @param T Temperature (kelvin) * @param P pressure (pascal) * @param ifunc Changes what's returned from the routine - * @return Returns a single doublereal whose meaning depends on ifunc: + * @returns a double whose meaning depends on ifunc: * - ifunc = 0 return value * - ifunc = 1 return temperature derivative * - ifunc = 2 return temperature second derivative @@ -201,7 +201,7 @@ public: //! Returns the saturation pressure given the temperature /*! * @param T temperature (kelvin) - * @return returns the saturation pressure (pascal) + * @returns the saturation pressure (pascal) */ doublereal satPressure(doublereal T); diff --git a/include/cantera/transport/LTPspecies.h b/include/cantera/transport/LTPspecies.h index c8d7efef2..e2e5cb7f4 100644 --- a/include/cantera/transport/LTPspecies.h +++ b/include/cantera/transport/LTPspecies.h @@ -100,7 +100,7 @@ public: /*! * (virtual from LTPspecies) * - * @return Returns a copy of this routine as a pointer to LTPspecies + * @returns a copy of this routine as a pointer to LTPspecies */ virtual LTPspecies* duplMyselfAsLTPspecies() const; diff --git a/include/cantera/transport/MixTransport.h b/include/cantera/transport/MixTransport.h index 8db2e6ab2..078413317 100644 --- a/include/cantera/transport/MixTransport.h +++ b/include/cantera/transport/MixTransport.h @@ -95,7 +95,7 @@ public: * * The units of lambda are W / m K which is equivalent to kg m / s^3 K. * - * @return Returns the mixture thermal conductivity, with units of W/m/K + * @returns the mixture thermal conductivity, with units of W/m/K */ virtual doublereal thermalConductivity(); diff --git a/include/cantera/transport/SimpleTransport.h b/include/cantera/transport/SimpleTransport.h index 1bc1b4cba..4054a793d 100644 --- a/include/cantera/transport/SimpleTransport.h +++ b/include/cantera/transport/SimpleTransport.h @@ -430,7 +430,7 @@ protected: * is to check whether the temperature has changed since the last call to * update_T(). If it hasn't then an immediate return is carried out. * - * @return Returns true if the temperature has changed, and false otherwise + * @returns true if the temperature has changed, and false otherwise */ virtual bool update_T(); diff --git a/include/cantera/transport/TransportBase.h b/include/cantera/transport/TransportBase.h index d3aa74abc..fc41cfb68 100644 --- a/include/cantera/transport/TransportBase.h +++ b/include/cantera/transport/TransportBase.h @@ -342,7 +342,7 @@ public: /*! * Units are in W / m K or equivalently kg m / s3 K * - * @return returns thermal conductivity in W/m/K. + * @returns thermal conductivity in W/m/K. */ virtual doublereal thermalConductivity() { throw NotImplementedError("Transport::thermalConductivity"); diff --git a/src/base/stringUtils.cpp b/src/base/stringUtils.cpp index 3939a7011..ab6a9f5a5 100644 --- a/src/base/stringUtils.cpp +++ b/src/base/stringUtils.cpp @@ -89,7 +89,7 @@ std::string lowercase(const std::string& s) //! Return the position of the first printable character in the string /*! * @param s input string - * @return Returns an int representing the first printable string. If + * @returns an int representing the first printable string. If * none returns the size of the string. */ static int firstChar(const std::string& s) @@ -107,7 +107,7 @@ static int firstChar(const std::string& s) //! Return the position of the last printable character in the string /*! * @param s input string - * @return Returns an int representing the first printable string. If + * @returns an int representing the first printable string. If * none returns -1. */ static int lastChar(const std::string& s) diff --git a/src/thermo/VPSSMgrFactory.h b/src/thermo/VPSSMgrFactory.h index 49d2565bc..f1ab75171 100644 --- a/src/thermo/VPSSMgrFactory.h +++ b/src/thermo/VPSSMgrFactory.h @@ -114,8 +114,7 @@ public: * @param phaseNode_ptr Pointer to the ThermoPhase phase XML Node * @param spDataNodeList Vector of XML_Nodes, each of which is a species XML * Node. There are m_kk of these. - * - * @return Returns a pointer to a newly created species + * @returns a pointer to a newly created species * property manager object. */ virtual VPSSMgr* newVPSSMgr(VPStandardStateTP* vp_ptr,