diff --git a/include/cantera/Edge.h b/include/cantera/Edge.h index 0b3db91a2..024fb6765 100644 --- a/include/cantera/Edge.h +++ b/include/cantera/Edge.h @@ -1,3 +1,4 @@ +//! @file Edge.h #ifndef CXX_EDGE #define CXX_EDGE diff --git a/include/cantera/GRI30.h b/include/cantera/GRI30.h index 6826cd366..36d8fea2b 100644 --- a/include/cantera/GRI30.h +++ b/include/cantera/GRI30.h @@ -1,3 +1,4 @@ +//! @file GRI30.h #ifndef CXX_GRI30H #define CXX_GRI30H diff --git a/include/cantera/IdealGasMix.h b/include/cantera/IdealGasMix.h index 1d34a420d..aec2423ac 100644 --- a/include/cantera/IdealGasMix.h +++ b/include/cantera/IdealGasMix.h @@ -1,3 +1,4 @@ +//! @file IdealGasMix.h #ifndef CXX_IDEALGASMIX #define CXX_IDEALGASMIX diff --git a/include/cantera/IncompressibleSolid.h b/include/cantera/IncompressibleSolid.h index 3d6c06ad0..ae8839bf6 100644 --- a/include/cantera/IncompressibleSolid.h +++ b/include/cantera/IncompressibleSolid.h @@ -1,3 +1,4 @@ +//! @file IncompressibleSolid.h #ifndef CXX_INCOMPRESSIBLE #define CXX_INCOMPRESSIBLE diff --git a/include/cantera/Metal.h b/include/cantera/Metal.h index 335ebab13..b059bf58a 100644 --- a/include/cantera/Metal.h +++ b/include/cantera/Metal.h @@ -1,3 +1,4 @@ +//! @file Metal.h #ifndef CXX_METAL #define CXX_METAL diff --git a/include/cantera/PureFluid.h b/include/cantera/PureFluid.h index c120aa168..09afcd2fa 100644 --- a/include/cantera/PureFluid.h +++ b/include/cantera/PureFluid.h @@ -1,3 +1,4 @@ +//! @file PureFluid.h #ifndef CXX_PUREFLUID #define CXX_PUREFLUID diff --git a/include/cantera/base/Array.h b/include/cantera/base/Array.h index 098fb2802..57b24cdb9 100644 --- a/include/cantera/base/Array.h +++ b/include/cantera/base/Array.h @@ -1,6 +1,5 @@ /** - * @file Array.h - * Header file for class Array2D + * @file Array.h Header file for class Cantera::Array2D */ // Copyright 2001 California Institute of Technology diff --git a/include/cantera/equil/MultiPhaseEquil.h b/include/cantera/equil/MultiPhaseEquil.h index 1c8be64f0..f41a626c0 100644 --- a/include/cantera/equil/MultiPhaseEquil.h +++ b/include/cantera/equil/MultiPhaseEquil.h @@ -1,3 +1,4 @@ +//! @file MultiPhaseEquil.h #ifndef CT_MULTIPHASE_EQUIL #define CT_MULTIPHASE_EQUIL diff --git a/include/cantera/equil/vcs_SpeciesProperties.h b/include/cantera/equil/vcs_SpeciesProperties.h index c4b2f2171..24aa0b899 100644 --- a/include/cantera/equil/vcs_SpeciesProperties.h +++ b/include/cantera/equil/vcs_SpeciesProperties.h @@ -1,4 +1,4 @@ - +//! @file vcs_SpeciesProperties.h #ifndef VCS_SPECIES_PROPERTIES_H #define VCS_SPECIES_PROPERTIES_H diff --git a/include/cantera/equil/vcs_species_thermo.h b/include/cantera/equil/vcs_species_thermo.h index 502359a14..f33e98265 100644 --- a/include/cantera/equil/vcs_species_thermo.h +++ b/include/cantera/equil/vcs_species_thermo.h @@ -1,3 +1,4 @@ +//! @file vcs_species_thermo.h /* * Copyright (2005) Sandia Corporation. Under the terms of diff --git a/include/cantera/kinetics/solveSP.h b/include/cantera/kinetics/solveSP.h index 202169c73..b7704c7b1 100644 --- a/include/cantera/kinetics/solveSP.h +++ b/include/cantera/kinetics/solveSP.h @@ -1,7 +1,6 @@ /** - * @file solveSP.h - * Header file for implicit surface problem solver - * (see \ref chemkinetics and class \link Cantera::solveSP solveSP\endlink). + * @file solveSP.h Header file for implicit surface problem solver (see \ref + * chemkinetics and class \link Cantera::solveSP solveSP\endlink). */ /* * Copyright 2004 Sandia Corporation. Under the terms of Contract diff --git a/include/cantera/numerics/RootFind.h b/include/cantera/numerics/RootFind.h index 0731b2f29..9281c671f 100644 --- a/include/cantera/numerics/RootFind.h +++ b/include/cantera/numerics/RootFind.h @@ -1,7 +1,7 @@ /** - * @file RootFind.h - * Header file for implicit nonlinear solver of a one dimensional function - * (see \ref numerics and class \link Cantera::RootFind RootFind\endlink). + * @file RootFind.h Header file for implicit nonlinear solver of a one + * dimensional function (see \ref numerics and class \link + * Cantera::RootFind RootFind\endlink). */ /* diff --git a/include/cantera/numerics/solveProb.h b/include/cantera/numerics/solveProb.h index 7f5ec69b6..cf3cd6607 100644 --- a/include/cantera/numerics/solveProb.h +++ b/include/cantera/numerics/solveProb.h @@ -1,7 +1,7 @@ /** - * @file solveProb.h - * Header file for implicit nonlinear solver with the option of a pseudotransient - * (see \ref numerics and class \link Cantera::solveProb solveProb\endlink). + * @file solveProb.h Header file for implicit nonlinear solver with the option + * of a pseudotransient (see \ref numerics and class \link + * Cantera::solveProb solveProb\endlink). */ /* diff --git a/include/cantera/thermo/EdgePhase.h b/include/cantera/thermo/EdgePhase.h index 38c64e120..6d66044a0 100644 --- a/include/cantera/thermo/EdgePhase.h +++ b/include/cantera/thermo/EdgePhase.h @@ -1,7 +1,7 @@ /** - * @file EdgePhase.h - * Declarations for the EdgePhase ThermoPhase object, which models the interface - * between two surfaces (see \ref thermoprops and \link Cantera::EdgePhase EdgePhase\endlink). + * @file EdgePhase.h Declarations for the EdgePhase ThermoPhase object, which + * models the interface between two surfaces (see \ref thermoprops and + * \link Cantera::EdgePhase EdgePhase\endlink). */ // Copyright 2002 California Institute of Technology diff --git a/include/cantera/thermo/IdealSolidSolnPhase.h b/include/cantera/thermo/IdealSolidSolnPhase.h index 8fff3953f..b9487dc92 100644 --- a/include/cantera/thermo/IdealSolidSolnPhase.h +++ b/include/cantera/thermo/IdealSolidSolnPhase.h @@ -1,12 +1,10 @@ /** - * @file IdealSolidSolnPhase.h - * Header file for an ideal solid solution model + * @file IdealSolidSolnPhase.h Header file for an ideal solid solution model * with incompressible thermodynamics (see \ref thermoprops and * \link Cantera::IdealSolidSolnPhase IdealSolidSolnPhase\endlink). * - * This class inherits from the Cantera class ThermoPhase - * and implements an ideal solid solution model with incompressible - * thermodynamics. + * This class inherits from the Cantera class ThermoPhase and implements an + * ideal solid solution model with incompressible thermodynamics. */ /* * Copyright 2006 Sandia Corporation. Under the terms of Contract diff --git a/include/cantera/thermo/MixedSolventElectrolyte.h b/include/cantera/thermo/MixedSolventElectrolyte.h index 47587dd84..d8928fd02 100644 --- a/include/cantera/thermo/MixedSolventElectrolyte.h +++ b/include/cantera/thermo/MixedSolventElectrolyte.h @@ -1,5 +1,5 @@ /** - * @file MargulesVPSSTP.h + * @file MixedSolventElectrolyte.h * Header for intermediate ThermoPhase object for phases which * employ gibbs excess free energy based formulations * (see \ref thermoprops diff --git a/include/cantera/thermo/mix_defs.h b/include/cantera/thermo/mix_defs.h index d252510e8..4d9e460d0 100644 --- a/include/cantera/thermo/mix_defs.h +++ b/include/cantera/thermo/mix_defs.h @@ -1,3 +1,4 @@ +//! @file mix_defs.h #ifndef CT_MIX_DEFS_H #define CT_MIX_DEFS_H diff --git a/include/cantera/thermo/speciesThermoTypes.h b/include/cantera/thermo/speciesThermoTypes.h index e390053a1..9f7ebd88c 100644 --- a/include/cantera/thermo/speciesThermoTypes.h +++ b/include/cantera/thermo/speciesThermoTypes.h @@ -1,6 +1,5 @@ /** - * @file speciesThermoTypes.h - * Contains const definitions for types of species + * @file speciesThermoTypes.h Contains const definitions for types of species * reference-state thermodynamics managers (see \ref spthermo) */ // Copyright 2001 California Institute of Technology diff --git a/include/cantera/tpx/Sub.h b/include/cantera/tpx/Sub.h index 717610f42..6a4a96512 100644 --- a/include/cantera/tpx/Sub.h +++ b/include/cantera/tpx/Sub.h @@ -1,3 +1,4 @@ +//! @file Sub.h #ifndef TPX_SUB_H #define TPX_SUB_H diff --git a/include/cantera/tpx/utils.h b/include/cantera/tpx/utils.h index ca9427d3b..7e516005c 100644 --- a/include/cantera/tpx/utils.h +++ b/include/cantera/tpx/utils.h @@ -1,3 +1,4 @@ +//! @file utils.h #ifndef TPX_UTILS_H #define TPX_UTILS_H diff --git a/include/cantera/transport/WaterTransport.h b/include/cantera/transport/WaterTransport.h index 8f0d4a247..6be75281d 100644 --- a/include/cantera/transport/WaterTransport.h +++ b/include/cantera/transport/WaterTransport.h @@ -1,6 +1,5 @@ /** - * @file WaterTransport.h - * Header file defining class LiquidTransport + * @file WaterTransport.h Header file defining class WaterTransport */ #ifndef CT_WATERTRAN_H #define CT_WATERTRAN_H diff --git a/src/base/application.cpp b/src/base/application.cpp index dd6c6f6c6..d8df3b2cd 100644 --- a/src/base/application.cpp +++ b/src/base/application.cpp @@ -1,3 +1,4 @@ +//! @file application.cpp #include "application.h" #include "cantera/base/ctexceptions.h" diff --git a/src/base/application.h b/src/base/application.h index 64b6cd6ae..2d9be1db7 100644 --- a/src/base/application.h +++ b/src/base/application.h @@ -1,3 +1,4 @@ +//! @file application.h #ifndef CT_BASE_APPLICATION_H #define CT_BASE_APPLICATION_H diff --git a/src/base/ctexceptions.cpp b/src/base/ctexceptions.cpp index 3b3d60f6d..2cafbb6e6 100644 --- a/src/base/ctexceptions.cpp +++ b/src/base/ctexceptions.cpp @@ -1,3 +1,4 @@ +//! @file ctexceptions.cpp #include "cantera/base/ctexceptions.h" #include "application.h" diff --git a/src/base/global.cpp b/src/base/global.cpp index 1b35b7d2e..3e6710cfa 100644 --- a/src/base/global.cpp +++ b/src/base/global.cpp @@ -1,3 +1,4 @@ +//! @file global.cpp #include "cantera/base/global.h" #include "cantera/base/ctexceptions.h" diff --git a/src/equil/vcs_TP.cpp b/src/equil/vcs_TP.cpp index 83dc4da1d..6c2c13835 100644 --- a/src/equil/vcs_TP.cpp +++ b/src/equil/vcs_TP.cpp @@ -1,3 +1,4 @@ +//! @file vcs_TP.cpp #include "cantera/equil/vcs_solve.h" #include "cantera/equil/vcs_internal.h" #include "cantera/equil/vcs_species_thermo.h" diff --git a/src/equil/vcs_report.cpp b/src/equil/vcs_report.cpp index 6b2136e78..d43495d5f 100644 --- a/src/equil/vcs_report.cpp +++ b/src/equil/vcs_report.cpp @@ -1,3 +1,4 @@ +//! @file vcs_report.cpp /* * Copyright (2005) Sandia Corporation. Under the terms of * Contract DE-AC04-94AL85000 with Sandia Corporation, the diff --git a/src/equil/vcs_solve.cpp b/src/equil/vcs_solve.cpp index 96ab28d45..9304e026f 100644 --- a/src/equil/vcs_solve.cpp +++ b/src/equil/vcs_solve.cpp @@ -1,6 +1,6 @@ /*! - * @file vcs_solve.h Header file for the internal class that holds the - * problem. + * @file vcs_solve.cpp Implementation file for the internal class that holds + * the problem. */ /* * Copyright (2005) Sandia Corporation. Under the terms of diff --git a/src/equil/vcs_solve_phaseStability.cpp b/src/equil/vcs_solve_phaseStability.cpp index 0b5428e8c..792c493b1 100644 --- a/src/equil/vcs_solve_phaseStability.cpp +++ b/src/equil/vcs_solve_phaseStability.cpp @@ -1,7 +1,4 @@ -/** - * @file vcs_solve_TP.cpp Implementation file that contains the - * main algorithm for finding an equilibrium - */ +//! @file vcs_solve_phaseStability.cpp /* * Copyright (2005) Sandia Corporation. Under the terms of diff --git a/src/kinetics/Kinetics.cpp b/src/kinetics/Kinetics.cpp index bb5c54fa4..f2cd7c013 100644 --- a/src/kinetics/Kinetics.cpp +++ b/src/kinetics/Kinetics.cpp @@ -1,10 +1,10 @@ /** - * @file Kinetics.cpp - * Declarations for the base class for kinetics - * managers (see \ref kineticsmgr and class - * \link Cantera::Kinetics Kinetics\endlink). + * @file Kinetics.cpp Declarations for the base class for kinetics managers + * (see \ref kineticsmgr and class \link Cantera::Kinetics + * Kinetics\endlink). * - * Kinetics managers calculate rates of progress of species due to homogeneous or heterogeneous kinetics. + * Kinetics managers calculate rates of progress of species due to + * homogeneous or heterogeneous kinetics. */ // Copyright 2001-2004 California Institute of Technology diff --git a/src/numerics/DAE_solvers.cpp b/src/numerics/DAE_solvers.cpp index 96fedbe08..9f89d88c0 100644 --- a/src/numerics/DAE_solvers.cpp +++ b/src/numerics/DAE_solvers.cpp @@ -1,6 +1,5 @@ /** - * @file DAE_solvers.cpp - * Factory routine for picking the DAE solver package + * @file DAE_solvers.cpp Factory routine for picking the DAE solver package */ /* diff --git a/src/numerics/Func1.cpp b/src/numerics/Func1.cpp index 71f2ce62f..0b7d7bd65 100644 --- a/src/numerics/Func1.cpp +++ b/src/numerics/Func1.cpp @@ -1,3 +1,4 @@ +//! @file Func1.cpp #include "cantera/numerics/Func1.h" #include "cantera/base/stringUtils.h" #include "cantera/base/global.h" diff --git a/src/numerics/ODE_integrators.cpp b/src/numerics/ODE_integrators.cpp index f533dba9c..4b480ae0e 100644 --- a/src/numerics/ODE_integrators.cpp +++ b/src/numerics/ODE_integrators.cpp @@ -1,3 +1,4 @@ +//! @file ODE_integrators.cpp #include "cantera/base/ct_defs.h" #include "cantera/numerics/Integrator.h" diff --git a/src/numerics/RootFind.cpp b/src/numerics/RootFind.cpp index 8f12785e9..582511ca4 100644 --- a/src/numerics/RootFind.cpp +++ b/src/numerics/RootFind.cpp @@ -1,4 +1,4 @@ -/* +/** * @file: RootFind.cpp root finder for 1D problems */ diff --git a/src/numerics/SquareMatrix.cpp b/src/numerics/SquareMatrix.cpp index e39572b7b..4e154e264 100644 --- a/src/numerics/SquareMatrix.cpp +++ b/src/numerics/SquareMatrix.cpp @@ -1,5 +1,5 @@ /** - * @file DenseMatrix.cpp + * @file SquareMatrix.cpp */ /* diff --git a/src/numerics/solveProb.cpp b/src/numerics/solveProb.cpp index 1257b9fd9..7e5238761 100644 --- a/src/numerics/solveProb.cpp +++ b/src/numerics/solveProb.cpp @@ -1,5 +1,5 @@ -/* - * @file: solveSP.cpp Implicit solver for nonlinear problems +/** + * @file: solveProb.cpp Implicit solver for nonlinear problems */ /* diff --git a/src/oneD/OneDim.cpp b/src/oneD/OneDim.cpp index af7276c04..8a15ac252 100644 --- a/src/oneD/OneDim.cpp +++ b/src/oneD/OneDim.cpp @@ -1,3 +1,4 @@ +//! @file OneDim.cpp #include "cantera/oneD/MultiJac.h" #include "cantera/oneD/MultiNewton.h" #include "cantera/oneD/OneDim.h" diff --git a/src/oneD/refine.cpp b/src/oneD/refine.cpp index 20eb00278..a1809d622 100644 --- a/src/oneD/refine.cpp +++ b/src/oneD/refine.cpp @@ -1,3 +1,4 @@ +//! @file refine.cpp #include "cantera/oneD/refine.h" #include "cantera/oneD/Domain1D.h" diff --git a/src/spectra/Nuclei.h b/src/spectra/Nuclei.h index 866a1bab7..64414695f 100644 --- a/src/spectra/Nuclei.h +++ b/src/spectra/Nuclei.h @@ -1,5 +1,5 @@ /** - * Provides class Nucleus + * @file Nuclei.h Provides class Nucleus */ #ifndef CT_NUCL_H diff --git a/src/thermo/IdealSolidSolnPhase.cpp b/src/thermo/IdealSolidSolnPhase.cpp index b1df4a3fb..f29c47a30 100644 --- a/src/thermo/IdealSolidSolnPhase.cpp +++ b/src/thermo/IdealSolidSolnPhase.cpp @@ -1,8 +1,8 @@ /** - * @file IdealSolidSolnPhase.cpp - * Implementation file for an ideal solid solution model - * with incompressible thermodynamics (see \ref thermoprops and - * \link Cantera::IdealSolidSolnPhase IdealSolidSolnPhase\endlink). + * @file IdealSolidSolnPhase.cpp Implementation file for an ideal solid + * solution model with incompressible thermodynamics (see \ref + * thermoprops and \link Cantera::IdealSolidSolnPhase + * IdealSolidSolnPhase\endlink). */ /* * Copyright 2006 Sandia Corporation. Under the terms of Contract diff --git a/src/thermo/LatticeSolidPhase.cpp b/src/thermo/LatticeSolidPhase.cpp index 96086bb05..e295c5874 100644 --- a/src/thermo/LatticeSolidPhase.cpp +++ b/src/thermo/LatticeSolidPhase.cpp @@ -1,7 +1,7 @@ /** - * @file LatticeSolidPhase.h + * @file LatticeSolidPhase.cpp * Definitions for a simple thermodynamics model of a bulk solid phase - * derived from %ThermoPhase, + * derived from ThermoPhase, * assuming an ideal solution model based on a lattice of solid atoms * (see \ref thermoprops and class \link Cantera::LatticeSolidPhase LatticeSolidPhase\endlink). */ diff --git a/src/thermo/MixedSolventElectrolyte.cpp b/src/thermo/MixedSolventElectrolyte.cpp index d411372dc..eaa746808 100644 --- a/src/thermo/MixedSolventElectrolyte.cpp +++ b/src/thermo/MixedSolventElectrolyte.cpp @@ -1,10 +1,9 @@ /** - * @file MargulesVPSSTP.cpp + * @file MixedSolventElectrolyte.cpp * Definitions for ThermoPhase object for phases which * employ excess gibbs free energy formulations related to Margules * expansions (see \ref thermoprops * and class \link Cantera::MargulesVPSSTP MargulesVPSSTP\endlink). - * */ /* * Copyright (2009) Sandia Corporation. Under the terms of diff --git a/src/thermo/SemiconductorPhase.cpp b/src/thermo/SemiconductorPhase.cpp index da35f4eb2..458669fb1 100644 --- a/src/thermo/SemiconductorPhase.cpp +++ b/src/thermo/SemiconductorPhase.cpp @@ -1,4 +1,4 @@ - +//! @file SemiconductorPhase.cpp #include "cantera/thermo/SemiconductorPhase.h" using namespace std; diff --git a/src/tpx/CarbonDioxide.cpp b/src/tpx/CarbonDioxide.cpp index 51fbbf9f7..41f7240b6 100644 --- a/src/tpx/CarbonDioxide.cpp +++ b/src/tpx/CarbonDioxide.cpp @@ -1,9 +1,8 @@ -/* FILE: CarbonDioxide.cpp - * DESCRIPTION: - * representation of substance Carbon Dioxide - * values and functions are from - * "Thermodynamic Properties in SI" by W.C. Reynolds - * AUTHOR: me@rebeccahhunt.com: GCEP, Stanford University +/** + * @file CarbonDioxide.cpp representation of substance Carbon Dioxide. + * + * Values and functions are from "Thermodynamic Properties in SI" by W.C. + * Reynolds AUTHOR: me@rebeccahhunt.com: GCEP, Stanford University */ #include "CarbonDioxide.h" diff --git a/src/tpx/CarbonDioxide.h b/src/tpx/CarbonDioxide.h index ffa4b2658..3dc76d2f6 100644 --- a/src/tpx/CarbonDioxide.h +++ b/src/tpx/CarbonDioxide.h @@ -1,3 +1,4 @@ +//! @file CarbonDioxide.h #ifndef TPX_CARBONDIOXIDE_H #define TPX_CARBONDIOXIDE_H diff --git a/src/tpx/HFC134a.cpp b/src/tpx/HFC134a.cpp index 7cf77a519..eababff51 100644 --- a/src/tpx/HFC134a.cpp +++ b/src/tpx/HFC134a.cpp @@ -1,4 +1,4 @@ -// HFC134a +//! @file HFC134a.cpp #include "HFC134a.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/HFC134a.h b/src/tpx/HFC134a.h index fffdf3f66..ce7d39dc8 100644 --- a/src/tpx/HFC134a.h +++ b/src/tpx/HFC134a.h @@ -1,3 +1,4 @@ +//! @file HFC134a.h #ifndef TPX_HFC134_H #define TPX_HFC134_H diff --git a/src/tpx/Heptane.cpp b/src/tpx/Heptane.cpp index 146ed7391..99a841dd9 100644 --- a/src/tpx/Heptane.cpp +++ b/src/tpx/Heptane.cpp @@ -1,10 +1,8 @@ -/* FILE: Heptane.cpp - * DESCRIPTION: - * representation of substance Heptane - * values and functions are from - * "Thermodynamic Properties in SI" bu W.C. Reynolds - * AUTHOR: jrh@stanford.edu: GCEP, Stanford University +/** + * @file Heptane.cpp representation of substance Heptane. * + * Values and functions are from "Thermodynamic Properties in SI" by W.C. + * Reynolds. AUTHOR: jrh@stanford.edu: GCEP, Stanford University */ #include "Heptane.h" diff --git a/src/tpx/Heptane.h b/src/tpx/Heptane.h index 80aa83d23..8731b36c5 100644 --- a/src/tpx/Heptane.h +++ b/src/tpx/Heptane.h @@ -1,3 +1,4 @@ +//! @file Heptane.h #ifndef TPX_HEPTANE_H #define TPX_HEPTANE_H diff --git a/src/tpx/Hydrogen.cpp b/src/tpx/Hydrogen.cpp index 6247df065..46add311e 100644 --- a/src/tpx/Hydrogen.cpp +++ b/src/tpx/Hydrogen.cpp @@ -1,3 +1,4 @@ +//! @file Hydrogen.cpp #include "Hydrogen.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/Hydrogen.h b/src/tpx/Hydrogen.h index d28d5dd4d..4d55dc465 100644 --- a/src/tpx/Hydrogen.h +++ b/src/tpx/Hydrogen.h @@ -1,3 +1,4 @@ +//! @file Hydrogen.h #ifndef TPX_HYDROGEN_H #define TPX_HYDROGEN_H diff --git a/src/tpx/Methane.cpp b/src/tpx/Methane.cpp index 016bde002..32a572edd 100644 --- a/src/tpx/Methane.cpp +++ b/src/tpx/Methane.cpp @@ -1,3 +1,4 @@ +//! @file Methane.cpp #include "Methane.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/Methane.h b/src/tpx/Methane.h index 851c95e4a..6524d9c2d 100644 --- a/src/tpx/Methane.h +++ b/src/tpx/Methane.h @@ -1,3 +1,4 @@ +//! @file Methane.h #ifndef TPX_METHANE_H #define TPX_METHANE_H diff --git a/src/tpx/Nitrogen.cpp b/src/tpx/Nitrogen.cpp index 830850a11..c40d25103 100644 --- a/src/tpx/Nitrogen.cpp +++ b/src/tpx/Nitrogen.cpp @@ -1,3 +1,4 @@ +//! @file Nitrogen.cpp #include "Nitrogen.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/Nitrogen.h b/src/tpx/Nitrogen.h index f2c75f201..f37ca9423 100644 --- a/src/tpx/Nitrogen.h +++ b/src/tpx/Nitrogen.h @@ -1,4 +1,4 @@ - +//! @file Nitrogen.h #ifndef TPX_NITROGEN_H #define TPX_NITROGEN_H diff --git a/src/tpx/Oxygen.cpp b/src/tpx/Oxygen.cpp index 1ab24bb3b..0b69e1538 100644 --- a/src/tpx/Oxygen.cpp +++ b/src/tpx/Oxygen.cpp @@ -1,3 +1,4 @@ +//! @file Oxygen.cpp #include "Oxygen.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/Oxygen.h b/src/tpx/Oxygen.h index 4d980fa21..c2c468522 100644 --- a/src/tpx/Oxygen.h +++ b/src/tpx/Oxygen.h @@ -1,3 +1,4 @@ +//! @file Oxygen.h #ifndef TPX_OXYGEN_H #define TPX_OXYGEN_H diff --git a/src/tpx/RedlichKwong.cpp b/src/tpx/RedlichKwong.cpp index f928be8b6..421f344ac 100644 --- a/src/tpx/RedlichKwong.cpp +++ b/src/tpx/RedlichKwong.cpp @@ -1,3 +1,4 @@ +//! @file RedlichKwong.cpp #include "RedlichKwong.h" namespace tpx diff --git a/src/tpx/RedlichKwong.h b/src/tpx/RedlichKwong.h index 62a472636..c2c44e679 100644 --- a/src/tpx/RedlichKwong.h +++ b/src/tpx/RedlichKwong.h @@ -1,3 +1,4 @@ +//! @file RedlichKwong.h #ifndef TPX_RK_H #define TPX_RK_H diff --git a/src/tpx/Sub.cpp b/src/tpx/Sub.cpp index 51d0ae8e0..9fbbfa0f1 100644 --- a/src/tpx/Sub.cpp +++ b/src/tpx/Sub.cpp @@ -1,3 +1,4 @@ +//! @file Sub.cpp /* * The Substance class * D. Goodwin, Caltech Nov. 1996 diff --git a/src/tpx/Water.cpp b/src/tpx/Water.cpp index 92fa25178..c4844022a 100644 --- a/src/tpx/Water.cpp +++ b/src/tpx/Water.cpp @@ -1,3 +1,4 @@ +//! @file Water.cpp #include "Water.h" #include "cantera/base/stringUtils.h" diff --git a/src/tpx/Water.h b/src/tpx/Water.h index 9b1dee418..8e760614b 100644 --- a/src/tpx/Water.h +++ b/src/tpx/Water.h @@ -1,3 +1,4 @@ +//! @file Water.h #ifndef TPX_WATER_H #define TPX_WATER_H diff --git a/src/tpx/lk.cpp b/src/tpx/lk.cpp index b18f25fdd..13a495177 100644 --- a/src/tpx/lk.cpp +++ b/src/tpx/lk.cpp @@ -1,4 +1,4 @@ -// Lee-Kesler equation of state +//! @file lk.cpp Lee-Kesler equation of state #include "lk.h" #include diff --git a/src/tpx/lk.h b/src/tpx/lk.h index 5a234192d..01ebef2d1 100644 --- a/src/tpx/lk.h +++ b/src/tpx/lk.h @@ -1,3 +1,4 @@ +//! @file lk.h Lee-Kesler equation of state #ifndef TPX_LK_H #define TPX_LK_H diff --git a/src/tpx/utils.cpp b/src/tpx/utils.cpp index e238bc903..d3ef3f3dc 100644 --- a/src/tpx/utils.cpp +++ b/src/tpx/utils.cpp @@ -1,3 +1,4 @@ +//! @file utils.cpp #include "cantera/tpx/utils.h" #include "cantera/base/stringUtils.h" diff --git a/src/transport/GasTransport.cpp b/src/transport/GasTransport.cpp index 31ed45f10..7cd9ef3a2 100644 --- a/src/transport/GasTransport.cpp +++ b/src/transport/GasTransport.cpp @@ -1,3 +1,4 @@ +//! @file GasTransport.cpp #include "cantera/transport/GasTransport.h" #include "cantera/transport/TransportParams.h" diff --git a/src/transport/LiquidTranInteraction.cpp b/src/transport/LiquidTranInteraction.cpp index 28146e481..bf1a64e47 100644 --- a/src/transport/LiquidTranInteraction.cpp +++ b/src/transport/LiquidTranInteraction.cpp @@ -1,5 +1,5 @@ /** - * @file LiquidTransportParams.cpp + * @file LiquidTranInteraction.cpp * Source code for liquid mixture transport property evaluations. */ diff --git a/src/transport/WaterTransport.cpp b/src/transport/WaterTransport.cpp index c738591c3..e0eb81813 100644 --- a/src/transport/WaterTransport.cpp +++ b/src/transport/WaterTransport.cpp @@ -1,3 +1,4 @@ +//! @file WaterTransport.cpp #include "cantera/base/ct_defs.h" #include "cantera/thermo/WaterPropsIAPWS.h" #include "cantera/transport/TransportBase.h" diff --git a/src/zeroD/FlowDevice.cpp b/src/zeroD/FlowDevice.cpp index 49fad4e2f..24bee4085 100644 --- a/src/zeroD/FlowDevice.cpp +++ b/src/zeroD/FlowDevice.cpp @@ -1,3 +1,4 @@ +//! @file FlowDevice.cpp #include "cantera/zeroD/FlowDevice.h" #include "cantera/zeroD/ReactorBase.h" #include "cantera/numerics/Func1.h" diff --git a/src/zeroD/ReactorNet.cpp b/src/zeroD/ReactorNet.cpp index 50e1400ee..2887027d3 100644 --- a/src/zeroD/ReactorNet.cpp +++ b/src/zeroD/ReactorNet.cpp @@ -1,3 +1,4 @@ +//! @file ReactorNet.cpp #include "cantera/zeroD/ReactorNet.h" #include "cantera/numerics/Integrator.h" #include "cantera/zeroD/FlowDevice.h" diff --git a/src/zeroD/Wall.cpp b/src/zeroD/Wall.cpp index 0a1b7ca0b..9f6680010 100644 --- a/src/zeroD/Wall.cpp +++ b/src/zeroD/Wall.cpp @@ -1,3 +1,4 @@ +//! @file Wall.cpp #include "cantera/zeroD/Wall.h" #include "cantera/zeroD/ReactorBase.h" #include "cantera/zeroD/ReactorNet.h"