Commit 7c98e1c7 authored by Matthieu Schaller's avatar Matthieu Schaller

Doxygen fixes

parent 9ffbf0a0
This diff is collapsed.
......@@ -221,11 +221,12 @@ const uint64_t *logger_reader_get_number_particles(struct logger_reader *reader,
* @param offset_last_full_record The offset of this particle last record
containing all the fields.
* @param field The fields wanted in local index.
* @param first_deriv_wanted The field that corresponds to the first derivative
of fields (-1 if none)
* @param second_deriv_wanted The field that corresponds to the second
derivative of field (-1 if none)
* @param first The field that corresponds to the first derivative of fields (-1
if none)
* @param second The field that corresponds to the second derivative of field
(-1 if none)
* @param output Pointers to the output array
* @param type The #part_type.
*/
void logger_reader_read_field(struct logger_reader *reader, double time,
size_t offset_time,
......
......@@ -5802,7 +5802,7 @@ void cell_drift_bpart(struct cell *c, const struct engine *e, int force) {
}
/**
* @brief Recursively drifts the #sinks in a cell hierarchy.
* @brief Recursively drifts the #sink's in a cell hierarchy.
*
* @param c The #cell.
* @param e The #engine (to get ti_current).
......
......@@ -52,6 +52,7 @@ INLINE static int chemistry_read_particles(struct part* parts,
* @param parts The particle array.
* @param xparts The extra particle array.
* @param list The list of i/o properties to write.
* @param with_cosmology Are we running with cosmology?
*
* @return Returns the number of fields to write.
*/
......
......@@ -63,6 +63,7 @@ INLINE static void convert_gas_metals(const struct engine* e,
* @param parts The particle array.
* @param xparts The extra particle array.
* @param list The list of i/o properties to write.
* @param with_cosmology Are we running with cosmology?
*
* @return Returns the number of fields to write.
*/
......
......@@ -44,6 +44,7 @@ INLINE static int chemistry_read_particles(struct part* parts,
* @param parts The particle array.
* @param xparts The extra particle array.
* @param list The list of i/o properties to write.
* @param with_cosmology Are we running with cosmology?
*
* @return Returns the number of fields to write.
*/
......
......@@ -44,6 +44,7 @@ INLINE static int chemistry_read_particles(struct part* parts,
* @param parts The particle array.
* @param xparts The extra particle array.
* @param list The list of i/o properties to write.
* @param with_cosmology Are we running with cosmology?
*
* @return Returns the number of fields to write.
*/
......
......@@ -582,6 +582,8 @@ __attribute__((always_inline)) INLINE void cooling_first_init_part(
* metallicity.
* @param XH The Hydrogen abundance of the gas.
* @param u_phys Internal energy of the gas in internal physical units.
* @param HII_region Is this patch of gas an HII region? (Not implemented in
* EAGLE)
*/
float cooling_get_temperature_from_gas(
const struct phys_const *phys_const, const struct cosmology *cosmo,
......
......@@ -380,6 +380,7 @@ void prepare_array_serial(
* @param N The number of particles to write.
* @param N_total The total number of particles on all ranks.
* @param offset The offset position where this rank starts writing.
* @param lossy_compression Lossy compression filter to apply.
* @param mpi_rank The MPI rank of this node
* @param internal_units The #unit_system used internally
* @param snapshot_units The #unit_system used in the snapshots
......@@ -503,6 +504,7 @@ void write_array_serial(const struct engine* e, hid_t grp, char* fileName,
* @param info The MPI information object
* @param n_threads The number of threads to use for local operations.
* @param dry_run If 1, don't read the particle. Only allocates the arrays.
* @param remap_ids Are we ignoring the ICs' IDs and remapping them to [1, N[ ?
*
* Opens the HDF5 file fileName and reads the particles contained
* in the parts array. N is the returned number of particles found
......
......@@ -44,6 +44,7 @@ __attribute__((always_inline)) INLINE static float sink_compute_timestep(
* read in to do some conversions.
*
* @param sp The particle to act upon
* @param sink_props The properties of the sink particles scheme.
*/
__attribute__((always_inline)) INLINE static void sink_first_init_sink(
struct sink* sp, const struct sink_props* sink_props) {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment