Add notices to documentation for classes with no tests or examples

See #267

include/cantera/kinetics/AqueousKinetics.h

@@ -18,6 +18,14 @@ namespace Cantera
  * Kinetics manager for elementary aqueous-phase chemistry. This kinetics
  * manager implements standard mass-action reaction rate expressions for liquids
  *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * @ingroup kinetics
  */
 class AqueousKinetics : public BulkKinetics

include/cantera/numerics/DAE_Solver.h

@@ -63,6 +63,14 @@ const int cKrylov = 1;
 
 /**
  * Wrapper for DAE solvers
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
  */
 class DAE_Solver
 {

include/cantera/numerics/IDA_Solver.h

@@ -39,6 +39,17 @@ public:
 
 class ResidData;
 
+/**
+ * Wrapper for Sundials IDA solver
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ */
 class IDA_Solver : public DAE_Solver
 {
 public:

include/cantera/numerics/ResidJacEval.h

@@ -40,6 +40,14 @@ enum ResidEval_Type_Enum {
 
 //! Wrappers for the function evaluators for Nonlinear solvers and Time steppers
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * A class for full (non-sparse dense matrices with Fortran-compatible data
  * storage. The class adds support for identifying what types of calls are made
  * to the residual evaluator by adding the ResidEval_Type_Enum class.

include/cantera/numerics/RootFind.h

@@ -43,6 +43,14 @@ namespace Cantera
 
 //! Root finder for 1D problems
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * The root finder solves a single nonlinear equation described below.
  *
  * \f[

include/cantera/thermo/AdsorbateThermo.h

@@ -21,6 +21,14 @@ namespace Cantera
 /**
  * An adsorbed surface species.
  *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * This class is designed specifically for use by the class MultiSpeciesThermo.
  * It implements a model for the thermodynamic properties of a molecule that can
  * be modeled as a set of independent quantum harmonic oscillators.

include/cantera/thermo/IonsFromNeutralVPSSTP.h

@@ -39,6 +39,14 @@ enum IonSolnType_enumType {
  * GibbsExcessVPSSTP object. All of the excess Gibbs free energy formulations in
  * this area employ symmetrical formulations.
  *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * This class is used for molten salts.
  *
  * This object actually employs 4 different mole fraction types.

include/cantera/thermo/MetalSHEelectrons.h

@@ -20,6 +20,15 @@ namespace Cantera
 //! Class MetalSHEelectrons represents electrons within a metal, adjacent to an
 //! aqueous electrolyte, that are consistent with the SHE reference electrode.
 /*!
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * The class is based on the electron having a chemical potential equal to one-
  * half of the entropy of the H2 gas at the system pressure
  *

include/cantera/thermo/MineralEQ3.h

@@ -19,6 +19,14 @@ namespace Cantera
 //! Class MineralEQ3 represents a stoichiometric (fixed composition)
 //! incompressible substance based on EQ3's parameterization
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * This class inherits from SingleSpeciesTP class. EQ's parameterization is
  * mapped onto the Shomate polynomial class.
  *

include/cantera/thermo/MixedSolventElectrolyte.h

@@ -16,6 +16,14 @@ namespace Cantera
 //! MixedSolventElectrolyte is a derived class of GibbsExcessVPSSTP that employs
 //! the DH and local Margules approximations for the excess Gibbs free energy
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * MixedSolventElectrolyte derives from class GibbsExcessVPSSTP which is derived
  * from VPStandardStateTP.
  *

include/cantera/thermo/MixtureFugacityTP.h

@@ -44,6 +44,14 @@ namespace Cantera
  * mixture is also allowed. The main subclass is currently a mixture Redlich-
  * Kwong class.
  *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * Several concepts are introduced. The first concept is there are temporary
  * variables for holding the species standard state values of Cp, H, S, G, and V
  * at the last temperature and pressure called. These functions are not

include/cantera/thermo/MolarityIonicVPSSTP.h

@@ -27,6 +27,14 @@ namespace Cantera
  * constituents. This category is the workhorse for describing ionic systems
  * which are not on the molality scale.
  *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * This class adds additional functions onto the ThermoPhase interface that
  * handles the calculation of the excess Gibbs free energy. The ThermoPhase
  * class includes a member function, ThermoPhase::activityConvention() that

include/cantera/thermo/PDSS_IonsFromNeutral.h

@@ -20,6 +20,14 @@ class ThermoPhase;
 
 //! Derived class for pressure dependent standard states of an ideal gas species
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * This class is for a single Ideal Gas species.
  *
  * @ingroup pdssthermo

include/cantera/thermo/PDSS_SSVol.h

@@ -19,6 +19,14 @@ namespace Cantera
 //! Class for pressure dependent standard states that uses a standard state
 //! volume model of some sort.
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * Class PDSS_SSVol is an implementation class that compute the properties of a
  * single species in a phase at its standard states, for a range of temperatures
  * and pressures. This particular class assumes that the calculation of the

include/cantera/thermo/PhaseCombo_Interaction.h

@@ -21,6 +21,14 @@ namespace Cantera
 //! the Margules approximation for the excess Gibbs free energy while
 //! eliminating the entropy of mixing term.
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * PhaseCombo_Interaction derives from class GibbsExcessVPSSTP which is derived
  * from VPStandardStateTP, and overloads the virtual methods defined there with
  * ones that use expressions appropriate for the Margules Excess Gibbs free

include/cantera/thermo/RedlichKwongMFTP.h

@@ -12,6 +12,16 @@
 namespace Cantera
 {
 /**
+ * Implementation of a multi-species Redlich-Kwong equation of state
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * @ingroup thermoprops
  */
 class RedlichKwongMFTP : public MixtureFugacityTP

include/cantera/thermo/VPSSMgr_IdealGas.h

@@ -18,6 +18,15 @@
 namespace Cantera
 {
 //! A VPSSMgr where all species in the phase obey an ideal gas equation of state
+/**
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ */
 class VPSSMgr_IdealGas : public VPSSMgr
 {
 public:

include/cantera/transport/HighPressureGasTransport.h

@@ -20,6 +20,14 @@ namespace Cantera
 //! Class MultiTransport implements transport properties for
 //! high pressure gas mixtures.
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * The implementation employs a method of corresponding states, using the
  * Takahashi approach for binary diffusion coefficients, (using multicomponent
  * averaging rules for the mixture properties, and the Lucas method for the

include/cantera/transport/LiquidTransport.h

@@ -18,6 +18,14 @@ namespace Cantera
 //! Class LiquidTransport implements models for transport
 //! properties for liquid phases.
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * Liquid Transport is set up with some flexibility in this class.  Transport
  * properties like viscosity and thermal conductivity are allowed flexibility
  * within the constraints of the LiquidTransportProperty and

include/cantera/transport/SolidTransport.h

@@ -18,6 +18,15 @@ namespace Cantera
 {
 //! Class SolidTransport implements transport properties for solids.
 //! @ingroup tranprops
+/*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ */
 class SolidTransport : public Transport
 {
 public:

include/cantera/transport/Tortuosity.h

@@ -16,6 +16,14 @@ namespace Cantera
 //! Specific Class to handle tortuosity corrections for diffusive transport
 //! in porous media using the Bruggeman exponent
 /*!
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
+ *
  * Class to compute the increase in diffusive path length associated with
  * tortuous path diffusion through, for example, porous media. This base class
  * implementation relates tortuosity to volume fraction through a power-law
@@ -73,6 +81,14 @@ protected:
 /**
  * This class implements transport coefficient corrections appropriate for
  * porous media where percolation theory applies.
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
  */
 class TortuosityPercolation : public Tortuosity
 {
@@ -118,6 +134,14 @@ protected:
  * \f[
  *    \kappa / \kappa_0 = 1 + 3 ( 1 - \phi ) ( r - 1 ) / ( r + 2 ) + O(\phi^2)
  * \f]
+ *
+ * @attention This class currently does not have any test cases or examples. Its
+ *     implementation may be incomplete, and future changes to Cantera may
+ *     unexpectedly cause this class to stop working. If you use this class,
+ *     please consider contributing examples or test cases. In the absence of
+ *     new tests or examples, this class may be deprecated and removed in a
+ *     future version of Cantera. See
+ *     https://github.com/Cantera/cantera/issues/267 for additional information.
  */
 class TortuosityMaxwell : public Tortuosity
 {