[Doxygen] Fix some incorrect/missing "@file" commands

This commit is contained in:
Ray Speth 2013-06-06 15:32:30 +00:00
parent 11170a0e32
commit a6614b87bb
71 changed files with 97 additions and 68 deletions

View file

@ -1,3 +1,4 @@
//! @file Edge.h
#ifndef CXX_EDGE
#define CXX_EDGE

View file

@ -1,3 +1,4 @@
//! @file GRI30.h
#ifndef CXX_GRI30H
#define CXX_GRI30H

View file

@ -1,3 +1,4 @@
//! @file IdealGasMix.h
#ifndef CXX_IDEALGASMIX
#define CXX_IDEALGASMIX

View file

@ -1,3 +1,4 @@
//! @file IncompressibleSolid.h
#ifndef CXX_INCOMPRESSIBLE
#define CXX_INCOMPRESSIBLE

View file

@ -1,3 +1,4 @@
//! @file Metal.h
#ifndef CXX_METAL
#define CXX_METAL

View file

@ -1,3 +1,4 @@
//! @file PureFluid.h
#ifndef CXX_PUREFLUID
#define CXX_PUREFLUID

View file

@ -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

View file

@ -1,3 +1,4 @@
//! @file MultiPhaseEquil.h
#ifndef CT_MULTIPHASE_EQUIL
#define CT_MULTIPHASE_EQUIL

View file

@ -1,4 +1,4 @@
//! @file vcs_SpeciesProperties.h
#ifndef VCS_SPECIES_PROPERTIES_H
#define VCS_SPECIES_PROPERTIES_H

View file

@ -1,3 +1,4 @@
//! @file vcs_species_thermo.h
/*
* Copyright (2005) Sandia Corporation. Under the terms of

View file

@ -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

View file

@ -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).
*/
/*

View file

@ -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).
*/
/*

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -1,3 +1,4 @@
//! @file mix_defs.h
#ifndef CT_MIX_DEFS_H
#define CT_MIX_DEFS_H

View file

@ -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

View file

@ -1,3 +1,4 @@
//! @file Sub.h
#ifndef TPX_SUB_H
#define TPX_SUB_H

View file

@ -1,3 +1,4 @@
//! @file utils.h
#ifndef TPX_UTILS_H
#define TPX_UTILS_H

View file

@ -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

View file

@ -1,3 +1,4 @@
//! @file application.cpp
#include "application.h"
#include "cantera/base/ctexceptions.h"

View file

@ -1,3 +1,4 @@
//! @file application.h
#ifndef CT_BASE_APPLICATION_H
#define CT_BASE_APPLICATION_H

View file

@ -1,3 +1,4 @@
//! @file ctexceptions.cpp
#include "cantera/base/ctexceptions.h"
#include "application.h"

View file

@ -1,3 +1,4 @@
//! @file global.cpp
#include "cantera/base/global.h"
#include "cantera/base/ctexceptions.h"

View file

@ -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"

View file

@ -1,3 +1,4 @@
//! @file vcs_report.cpp
/*
* Copyright (2005) Sandia Corporation. Under the terms of
* Contract DE-AC04-94AL85000 with Sandia Corporation, the

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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
*/
/*

View file

@ -1,3 +1,4 @@
//! @file Func1.cpp
#include "cantera/numerics/Func1.h"
#include "cantera/base/stringUtils.h"
#include "cantera/base/global.h"

View file

@ -1,3 +1,4 @@
//! @file ODE_integrators.cpp
#include "cantera/base/ct_defs.h"
#include "cantera/numerics/Integrator.h"

View file

@ -1,4 +1,4 @@
/*
/**
* @file: RootFind.cpp root finder for 1D problems
*/

View file

@ -1,5 +1,5 @@
/**
* @file DenseMatrix.cpp
* @file SquareMatrix.cpp
*/
/*

View file

@ -1,5 +1,5 @@
/*
* @file: solveSP.cpp Implicit solver for nonlinear problems
/**
* @file: solveProb.cpp Implicit solver for nonlinear problems
*/
/*

View file

@ -1,3 +1,4 @@
//! @file OneDim.cpp
#include "cantera/oneD/MultiJac.h"
#include "cantera/oneD/MultiNewton.h"
#include "cantera/oneD/OneDim.h"

View file

@ -1,3 +1,4 @@
//! @file refine.cpp
#include "cantera/oneD/refine.h"
#include "cantera/oneD/Domain1D.h"

View file

@ -1,5 +1,5 @@
/**
* Provides class Nucleus
* @file Nuclei.h Provides class Nucleus
*/
#ifndef CT_NUCL_H

View file

@ -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

View file

@ -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).
*/

View file

@ -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

View file

@ -1,4 +1,4 @@
//! @file SemiconductorPhase.cpp
#include "cantera/thermo/SemiconductorPhase.h"
using namespace std;

View file

@ -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"

View file

@ -1,3 +1,4 @@
//! @file CarbonDioxide.h
#ifndef TPX_CARBONDIOXIDE_H
#define TPX_CARBONDIOXIDE_H

View file

@ -1,4 +1,4 @@
// HFC134a
//! @file HFC134a.cpp
#include "HFC134a.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file HFC134a.h
#ifndef TPX_HFC134_H
#define TPX_HFC134_H

View file

@ -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"

View file

@ -1,3 +1,4 @@
//! @file Heptane.h
#ifndef TPX_HEPTANE_H
#define TPX_HEPTANE_H

View file

@ -1,3 +1,4 @@
//! @file Hydrogen.cpp
#include "Hydrogen.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file Hydrogen.h
#ifndef TPX_HYDROGEN_H
#define TPX_HYDROGEN_H

View file

@ -1,3 +1,4 @@
//! @file Methane.cpp
#include "Methane.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file Methane.h
#ifndef TPX_METHANE_H
#define TPX_METHANE_H

View file

@ -1,3 +1,4 @@
//! @file Nitrogen.cpp
#include "Nitrogen.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,4 +1,4 @@
//! @file Nitrogen.h
#ifndef TPX_NITROGEN_H
#define TPX_NITROGEN_H

View file

@ -1,3 +1,4 @@
//! @file Oxygen.cpp
#include "Oxygen.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file Oxygen.h
#ifndef TPX_OXYGEN_H
#define TPX_OXYGEN_H

View file

@ -1,3 +1,4 @@
//! @file RedlichKwong.cpp
#include "RedlichKwong.h"
namespace tpx

View file

@ -1,3 +1,4 @@
//! @file RedlichKwong.h
#ifndef TPX_RK_H
#define TPX_RK_H

View file

@ -1,3 +1,4 @@
//! @file Sub.cpp
/*
* The Substance class
* D. Goodwin, Caltech Nov. 1996

View file

@ -1,3 +1,4 @@
//! @file Water.cpp
#include "Water.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file Water.h
#ifndef TPX_WATER_H
#define TPX_WATER_H

View file

@ -1,4 +1,4 @@
// Lee-Kesler equation of state
//! @file lk.cpp Lee-Kesler equation of state
#include "lk.h"
#include <math.h>

View file

@ -1,3 +1,4 @@
//! @file lk.h Lee-Kesler equation of state
#ifndef TPX_LK_H
#define TPX_LK_H

View file

@ -1,3 +1,4 @@
//! @file utils.cpp
#include "cantera/tpx/utils.h"
#include "cantera/base/stringUtils.h"

View file

@ -1,3 +1,4 @@
//! @file GasTransport.cpp
#include "cantera/transport/GasTransport.h"
#include "cantera/transport/TransportParams.h"

View file

@ -1,5 +1,5 @@
/**
* @file LiquidTransportParams.cpp
* @file LiquidTranInteraction.cpp
* Source code for liquid mixture transport property evaluations.
*/

View file

@ -1,3 +1,4 @@
//! @file WaterTransport.cpp
#include "cantera/base/ct_defs.h"
#include "cantera/thermo/WaterPropsIAPWS.h"
#include "cantera/transport/TransportBase.h"

View file

@ -1,3 +1,4 @@
//! @file FlowDevice.cpp
#include "cantera/zeroD/FlowDevice.h"
#include "cantera/zeroD/ReactorBase.h"
#include "cantera/numerics/Func1.h"

View file

@ -1,3 +1,4 @@
//! @file ReactorNet.cpp
#include "cantera/zeroD/ReactorNet.h"
#include "cantera/numerics/Integrator.h"
#include "cantera/zeroD/FlowDevice.h"

View file

@ -1,3 +1,4 @@
//! @file Wall.cpp
#include "cantera/zeroD/Wall.h"
#include "cantera/zeroD/ReactorBase.h"
#include "cantera/zeroD/ReactorNet.h"