Closed speth closed 1 year ago
@speth sure thing!
@anthony-walker ... while this is on the main repository, could you also add a little to docstrings handled by Doxygen?
MoleReactor
specializations do not have "brief" docstrings, as evident under the "Classes" section in the Reactor overview~ Edit: after checking on the source, it appears that this is a Doxygen issue, as it doesn't automatically process \*!
the same way as `*`. I added a fix to Cantera/cantera#1559, see https://github.com/Cantera/cantera/pull/1559/commits/5b0fb190f9d22aa6e0a16a5aa3caab6a78f765c3*@ischoegl I will have a look.
@ischoegl I will have a look.
Thank you! One thing we just added is the Doxygen @cite
feature to support BibTeX citations. See https://cantera.org/documentation/dev/doxygen/html/d0/de3/citelist.html
The governing equations for the mole-based reactor types (
MoleReactor
,ConstPressureMoleReactor
,IdealGasMoleReactor
, andIdealGasConstPressureMoleReactor
) need to be documented here: https://cantera.org/science/reactors/reactors.html#reactor-types-and-governing-equations.@anthony-walker, can you help with this?