From 0bbd0879d56e11ec2c0f11d816977a2aea548c12 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Tue, 23 Mar 2010 15:28:06 +0000
Subject: [PATCH] Added doxygen comments.

---
 Cantera/src/base/ct_defs.h | 21 +++++++++++++++------
 Cantera/src/base/misc.cpp  |  6 +++++-
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/Cantera/src/base/ct_defs.h b/Cantera/src/base/ct_defs.h
index 85e5e8334..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
diff --git a/Cantera/src/base/misc.cpp b/Cantera/src/base/misc.cpp
index c116b604d..8750abe59 100644
--- a/Cantera/src/base/misc.cpp
+++ b/Cantera/src/base/misc.cpp
@@ -195,8 +195,9 @@ namespace Cantera {
 
       //! Copy Constructor for the Messages class
       /*!
-       * constructor for the Messages class which is a subclass
+       * Constructor for the Messages class which is a subclass
        * of the Application class.
+       *  @param r   Message to be copied
        */
       Messages(const Messages &r) :
 	errorMessage(r.errorMessage),
@@ -216,6 +217,9 @@ namespace Cantera {
       }
 
       //! Assignment operator
+      /*!
+       *  @param r   Message to be copied
+       */
       Messages & operator=(const Messages &r) 
       {
 	if (this == &r) {