doxygen update-

This contains changes to comments, to reduce number of dox warnings.
This commit is contained in:
Harry Moffat 2007-06-08 15:01:53 +00:00
parent d36aa23362
commit f4bb23178c
5 changed files with 27 additions and 11 deletions

View file

@ -70,6 +70,9 @@ namespace Cantera {
virtual ~SimpleThermo() {}
//! Copy constructor
/*!
* @param right Object to be copied
*/
SimpleThermo(const SimpleThermo &right) :
ID(SIMPLE),
m_tlow_max(0.0),
@ -83,7 +86,10 @@ namespace Cantera {
}
//! Assignment operator
SimpleThermo& SimpleThermo::operator=(const SimpleThermo &right) {
/*!
* @param right Object to be copied
*/
SimpleThermo& operator=(const SimpleThermo &right) {
/*
* Check for self assignment.
*/

View file

@ -36,9 +36,10 @@ using namespace ctml;
namespace Cantera {
SpeciesThermoFactory* SpeciesThermoFactory::s_factory = 0;
#if defined(THREAD_SAFE_CANTERA)
boost::mutex SpeciesThermoFactory::species_thermo_mutex ;
#endif
#if defined(THREAD_SAFE_CANTERA)
boost::mutex SpeciesThermoFactory::species_thermo_mutex ;
#endif
/**

View file

@ -90,7 +90,7 @@ namespace Cantera {
*/
virtual void deleteFactory() {
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (s_factory) {
delete s_factory;
@ -163,7 +163,8 @@ namespace Cantera {
static SpeciesThermoFactory* s_factory;
#if defined(THREAD_SAFE_CANTERA)
static boost::mutex species_thermo_mutex;
//! Decl of the static mutex variable that locks the %SpeciesThermo factory singelton
static boost::mutex species_thermo_mutex;
#endif
//! Constructor. This is made private, so that only the static

View file

@ -158,6 +158,9 @@ namespace Cantera {
virtual ~SpeciesThermoDuo(){}
//! copy constructor
/*!
* @param right Object to be copied
*/
SpeciesThermoDuo(const SpeciesThermoDuo &right) {
*this = operator=(right);
}
@ -407,6 +410,9 @@ namespace Cantera {
virtual ~SpeciesThermo1(){}
//! Copy Constructor
/*!
* @param right Object to be copied
*/
SpeciesThermo1(const SpeciesThermo1 &right) :
m_pref(0.0)
{

View file

@ -29,7 +29,7 @@
namespace Cantera {
class SpeciesThermoFactory;
class SpeciesThermoFactory;
/*!
* @addtogroup thermoprops
@ -65,7 +65,7 @@ namespace Cantera {
* This class keeps a list of the known ThermoPhase classes, and is
* used to create new instances of these classes.
*/
class ThermoFactory : public FactoryBase {
class ThermoFactory : public FactoryBase {
public:
@ -113,11 +113,13 @@ namespace Cantera {
//! static member of a single instance
static ThermoFactory* s_factory;
//! Private constructor prevents usage
ThermoFactory(){}
//! Private constructors prevents usage
ThermoFactory(){};
#if defined(THREAD_SAFE_CANTERA)
static boost::mutex thermo_mutex;
//! Decl for locking mutex for thermo factory singelton
static boost::mutex thermo_mutex;
#endif
};