Skip to content

Commit

Permalink
[docs] Add missing parameters
Browse files Browse the repository at this point in the history
All parameters have to be listed to remove warnings. For arguments
with known interpretation, a docstring is added.
  • Loading branch information
ischoegl committed Aug 2, 2023
1 parent 054cb80 commit e1f6b82
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion include/cantera/equil/ChemEquil.h
Expand Up @@ -238,7 +238,10 @@ class ChemEquil
* Given a vector of dimensionless element abundances, this routine
* calculates the moles of the elements and the moles of the species.
*
* @param[in] x = current dimensionless element potentials..
* @param s ThermoPhase object
* @param[in] x current dimensionless element potentials
* @param[in] Xmol_i_calc Mole fractions of the species
* @param[in] pressureConst Pressure
*/
double calcEmoles(ThermoPhase& s, vector_fp& x,
const double& n_t, const vector_fp& Xmol_i_calc,
Expand Down

0 comments on commit e1f6b82

Please sign in to comment.