From 704cc1d969e0896a83689dc4d844d979ab308150 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Fri, 2 Jan 2009 20:04:17 +0000
Subject: [PATCH] doxygen commits.

---
 Cantera/src/thermo/HMWSoln.h               |  2 +-
 Cantera/src/thermo/MineralEQ3.h            | 21 +++++++++------------
 Cantera/src/thermo/PDSS_Water.h            |  2 +-
 Cantera/src/thermo/StoichSubstanceSSTP.cpp |  6 +++---
 Cantera/src/thermo/StoichSubstanceSSTP.h   | 15 +++++++++++----
 5 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/Cantera/src/thermo/HMWSoln.h b/Cantera/src/thermo/HMWSoln.h
index d24adae53..4252fbcd9 100644
--- a/Cantera/src/thermo/HMWSoln.h
+++ b/Cantera/src/thermo/HMWSoln.h
@@ -2225,7 +2225,7 @@ namespace Cantera {
     /*! 
      *  See the Eq3/6 Manual for a thorough discussion of the need
      */
-    void HMWSoln::s_updateScaling_pHScaling_dT2() const;
+    void s_updateScaling_pHScaling_dT2() const;
 
     //!  Apply the current phScale to a set of derivatives of the activity Coefficients
     //!  wrt pressure
diff --git a/Cantera/src/thermo/MineralEQ3.h b/Cantera/src/thermo/MineralEQ3.h
index 75472628d..cfc130d7f 100644
--- a/Cantera/src/thermo/MineralEQ3.h
+++ b/Cantera/src/thermo/MineralEQ3.h
@@ -1,8 +1,8 @@
 /**
- *  @file StoichSubstanceSSTP.h
- * Header file for the StoichSubstanceSSTP class, which represents a fixed-composition
- * incompressible substance (see \ref thermoprops and 
- * class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
+ *  @file MineralEQ3.h
+ * Header file for the MineralEQ3 class, which represents a fixed-composition
+ * incompressible substance based on EQ3's parameterization (see \ref thermoprops and 
+ * class \link Cantera::MineralEQ3 MineralEQ3\endlink)
  */
 
 /*
@@ -11,10 +11,9 @@
  * U.S. Government retains certain rights in this software.
  */
 
-/*  $Author$
+/* 
  *  $Date$
  *  $Revision$
- *
  */
 
 #ifndef CT_MINERALEQ3_H
@@ -27,13 +26,11 @@
 
 namespace Cantera {
 
-  //!  Class %StoichSubstanceSSTP represents a stoichiometric (fixed
-  //!   composition)  incompressible substance.
+  //!  Class %MineralEQ3 represents a stoichiometric (fixed
+  //!   composition)  incompressible substance based on EQ3's parameterization
   /*!
-   * This class internally changes the independent degree of freedom from
-   * density to pressure. This is necessary because the phase is
-   * incompressible. It uses a constant volume approximation.
-   *
+   *  This class inherits from SingleSpeciesSSTP class.
+   *  EQ's parameterization is mapped onto the Shomate polynomial class.
    *
    * <b> Specification of Species Standard %State Properties </b>
    *
diff --git a/Cantera/src/thermo/PDSS_Water.h b/Cantera/src/thermo/PDSS_Water.h
index 058c5e5f5..22cb21b3c 100644
--- a/Cantera/src/thermo/PDSS_Water.h
+++ b/Cantera/src/thermo/PDSS_Water.h
@@ -242,7 +242,7 @@ namespace Cantera {
      *
      * @param temp  Temperature (Kelvin)
      */
-    doublereal PDSS_Water::pref_safe(doublereal temp) const;
+    doublereal pref_safe(doublereal temp) const;
 
 
     //! Return the molar gibbs free energy divided by RT at reference pressure
diff --git a/Cantera/src/thermo/StoichSubstanceSSTP.cpp b/Cantera/src/thermo/StoichSubstanceSSTP.cpp
index baebef116..565e7cfc5 100644
--- a/Cantera/src/thermo/StoichSubstanceSSTP.cpp
+++ b/Cantera/src/thermo/StoichSubstanceSSTP.cpp
@@ -1,6 +1,6 @@
 /**
  *  @file StoichSubstanceSSTP.cpp
- *   Definition file for the StoichSubstanceSSTP class, which represents a fixed-composition
+ * Definition file for the StoichSubstanceSSTP class, which represents a fixed-composition
  * incompressible substance (see \ref thermoprops and 
  * class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
  */
@@ -21,10 +21,10 @@
 #include "mix_defs.h"
 #include "StoichSubstanceSSTP.h"
 #include "SpeciesThermo.h"
-#include <string>
-//#include "importCTML.h"
 #include "ThermoFactory.h"
 
+#include <string>
+
 namespace Cantera {
 
   /*
diff --git a/Cantera/src/thermo/StoichSubstanceSSTP.h b/Cantera/src/thermo/StoichSubstanceSSTP.h
index 834c29d97..59b5598c4 100644
--- a/Cantera/src/thermo/StoichSubstanceSSTP.h
+++ b/Cantera/src/thermo/StoichSubstanceSSTP.h
@@ -1,5 +1,5 @@
 /**
- *  @file StoichSubstanceSSTP.h
+ * @file StoichSubstanceSSTP.h
  * Header file for the StoichSubstanceSSTP class, which represents a fixed-composition
  * incompressible substance (see \ref thermoprops and 
  * class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
@@ -11,10 +11,9 @@
  * U.S. Government retains certain rights in this software.
  */
 
-/*  $Author$
+/*
  *  $Date$
  *  $Revision$
- *
  */
 
 #ifndef CT_STOICHSUBSTANCESSTP_H
@@ -527,9 +526,17 @@ namespace Cantera {
 
   };
      
-
+  //!  Class %electrodeElectron represents an electron in a 
+  //!  metal using the Standard hydrogen reference electrode 
+  /*!
+   * 
+   *  The class is based on the electron have a chemical potential
+   *  equal to one-half of the entropy of the H2 gas at 1 bar.
+   *
+   */
   class electrodeElectron : public StoichSubstanceSSTP  {
   public:
+
     //! Default constructor for the electrodeElectron class
     electrodeElectron();