research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix formatting of Doxygen comments for Reaction classes

Browse source
This commit is contained in:
Ray Speth 2014-11-19 20:27:38 +00:00
parent 7a4d13a5c2
commit c1e4430c8a
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
include/cantera/kinetics/Reaction.h
View file

@ -29,7 +29,7 @@ public:
std::string equation() const; std::string equation() const;
//! Ensure that the rate constant and other parameters for this reaction are //! Ensure that the rate constant and other parameters for this reaction are
//valid. //! valid.
virtual void validate(); virtual void validate();
//! Type of the reaction. The valid types are listed in the file, //! Type of the reaction. The valid types are listed in the file,
@ -58,7 +58,7 @@ public:
bool duplicate; bool duplicate;
//! True if reaction orders can be specified for non-reactant species. //! True if reaction orders can be specified for non-reactant species.
//Default is `false`. //! Default is `false`.
bool allow_nonreactant_orders; bool allow_nonreactant_orders;
//! True if negative reaction orders are allowed. Default is `false`. //! True if negative reaction orders are allowed. Default is `false`.
@ -195,12 +195,12 @@ public:
//! the parameterization. //! the parameterization.
std::map<std::string, CoverageDependency> coverage_deps; std::map<std::string, CoverageDependency> coverage_deps;
// Set to true if `rate` is a parameterization of the sticking coefficient //! Set to true if `rate` is a parameterization of the sticking coefficient
// rather than the forward rate constant //! rather than the forward rate constant
bool is_sticking_coefficient; bool is_sticking_coefficient;
// For reactions with multiple non-surface species, the sticking species //! For reactions with multiple non-surface species, the sticking species
// needs to be explicitly identified. //! needs to be explicitly identified.
std::string sticking_species; std::string sticking_species;
}; };