From 035c6d4ca1476a9b454cfb468ea4df2857608a64 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 7 Oct 2015 13:33:54 -0400 Subject: [PATCH] [Doc] Add Doxygen docstrings for wrapper classes Without at least a basic docstring, these classes are excluded from the Doxygen documentation. --- include/cantera/Edge.h | 1 + include/cantera/IdealGasMix.h | 1 + include/cantera/IncompressibleSolid.h | 1 + include/cantera/Metal.h | 1 + include/cantera/PureFluid.h | 1 + 5 files changed, 5 insertions(+) diff --git a/include/cantera/Edge.h b/include/cantera/Edge.h index 725816504..4eea96814 100644 --- a/include/cantera/Edge.h +++ b/include/cantera/Edge.h @@ -9,6 +9,7 @@ namespace Cantera { +//! Convenience class which inherits from both EdgePhase and EdgeKinetics class Edge : public EdgePhase, public EdgeKinetics { diff --git a/include/cantera/IdealGasMix.h b/include/cantera/IdealGasMix.h index aec2423ac..dc6f498c7 100644 --- a/include/cantera/IdealGasMix.h +++ b/include/cantera/IdealGasMix.h @@ -10,6 +10,7 @@ namespace Cantera { +//! Convenience class which inherits from both IdealGasPhase and GasKinetics class IdealGasMix : public IdealGasPhase, public GasKinetics diff --git a/include/cantera/IncompressibleSolid.h b/include/cantera/IncompressibleSolid.h index ae8839bf6..930df677b 100644 --- a/include/cantera/IncompressibleSolid.h +++ b/include/cantera/IncompressibleSolid.h @@ -8,6 +8,7 @@ namespace Cantera { +//! Wrapper for ConstDensityThermo with constructor from file class IncompressibleSolid : public ConstDensityThermo { public: diff --git a/include/cantera/Metal.h b/include/cantera/Metal.h index a7508c78e..4fcb8ade2 100644 --- a/include/cantera/Metal.h +++ b/include/cantera/Metal.h @@ -8,6 +8,7 @@ namespace Cantera { +//! Wrapper for MetalPhase with constructor from file class Metal : public MetalPhase { public: diff --git a/include/cantera/PureFluid.h b/include/cantera/PureFluid.h index 7c5f5a57b..4d744971f 100644 --- a/include/cantera/PureFluid.h +++ b/include/cantera/PureFluid.h @@ -8,6 +8,7 @@ namespace Cantera { +//! Wrapper for PureFluidPhase with constructor from file class PureFluid : public PureFluidPhase { public: