Added a detailed doxygen member function description.

2005-10-21 22:16:37 +00:00 · 2005-10-21 22:16:37 +00:00 · 18ffa552d1
commit 18ffa552d1
parent b4dcb8a231
1 changed files with 3 additions and 0 deletions
--- a/Cantera/src/ThermoPhase.h
+++ b/Cantera/src/ThermoPhase.h
@ -523,6 +523,9 @@ namespace Cantera {
         *  Returns the vector of nondimensional
         *  enthalpies of the reference state at the current temperature
         *  of the solution and the reference pressure for the species.
+         *
+         *  This base function will throw a CanteraException unless
+         *  it is overwritten in a derived class.
         */
        virtual void getEnthalpy_RT_ref(doublereal *hrt) const {
            err("getEnthalpy_RT_ref");