From db3de591af55d7b7f1a3e2fd3edb1fac930203c0 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Fri, 7 May 2010 14:41:34 +0000
Subject: [PATCH] Added comments. Added deprecated symbol for array_fp

---
 Cantera/src/base/ct_defs.h | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/Cantera/src/base/ct_defs.h b/Cantera/src/base/ct_defs.h
index c394cadb7..1930ba377 100644
--- a/Cantera/src/base/ct_defs.h
+++ b/Cantera/src/base/ct_defs.h
@@ -76,21 +76,30 @@ namespace Cantera {
    */
   //@{
 
-    /// Avogadro's Number
-    const doublereal Avogadro = 6.02214179e26; //   /kmol
+    //! Avogadro's Number
+    /*!
+     *  Units are number/kmol
+     */
+    const doublereal Avogadro = 6.02214179e26; 
 
     /// Universal Gas Constant. 2006 CODATA value.
     const doublereal GasConstant = 8314.47215; // J/kmol/K
 
     const doublereal logGasConstant = 9.025752908;
 
-    /// One atmosphere
-    const doublereal OneAtm = 1.01325e5;             // Pa
+    //! One atmosphere
+    /*!
+     *  Units are Pa
+     */
+    const doublereal OneAtm = 1.01325e5;  
 
-    /// Universal gas constant in cal/mol/K
+    //! Universal gas constant in cal/mol/K
     const doublereal GasConst_cal_mol_K = 1.987;
 
-    /// Boltzmann's constant
+    //! Boltzmann's constant
+    /*!
+     *  Units are J/K
+     */
     const doublereal Boltzmann = GasConstant / Avogadro;
 
     /// Planck's constant. Units of J-s
@@ -191,6 +200,9 @@ namespace Cantera {
 #define USE_STL_VECTOR
 #ifdef USE_STL_VECTOR
   //! Vector of doubles.
+  /*!
+   *  @deprecated array_fp is going away, because vector_fp means the same thing
+   */
     typedef std::vector<double>        array_fp;
   //! Vector of doubles.
     typedef std::vector<double>        vector_fp;