[Doc] Add Doxygen docstrings for wrapper classes

Without at least a basic docstring, these classes are excluded from the Doxygen
documentation.
This commit is contained in:
Ray Speth 2015-10-07 13:33:54 -04:00
parent 3914ede44a
commit fbf93bf270
5 changed files with 5 additions and 0 deletions

View file

@ -9,6 +9,7 @@
namespace Cantera
{
//! Convenience class which inherits from both EdgePhase and EdgeKinetics
class Edge :
public EdgePhase, public EdgeKinetics
{

View file

@ -10,6 +10,7 @@
namespace Cantera
{
//! Convenience class which inherits from both IdealGasPhase and GasKinetics
class IdealGasMix :
public IdealGasPhase,
public GasKinetics

View file

@ -8,6 +8,7 @@
namespace Cantera
{
//! Wrapper for ConstDensityThermo with constructor from file
class IncompressibleSolid : public ConstDensityThermo
{
public:

View file

@ -8,6 +8,7 @@
namespace Cantera
{
//! Wrapper for MetalPhase with constructor from file
class Metal : public MetalPhase
{
public:

View file

@ -8,6 +8,7 @@
namespace Cantera
{
//! Wrapper for PureFluidPhase with constructor from file
class PureFluid : public PureFluidPhase
{
public: