Improve Doxygen documentation
-
improve documentation (see below, 8h) -
add documentation build to continuous integration (4h)
The Doxygen documentation may be incomplete; it may be spread over header and source file.
Example: melissa_expose()
In api/melissa_api.h
:
/// returns false if simulation should end now.
int melissa_expose(const char *field_name, double *values,
double *hidden_values);
In api/melissa_api.cxx
:
/// returns 0 if simulation should end now.
/// otherwise returns nsteps, the number of timesteps that need to be simulated.
int melissa_expose(const char *field_name, double *values,
double *hidden_values)
Edited by FRIEDEMANN Sebastian