Commit b3421a96 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Documentation fixes

parent c8671f27
...@@ -1310,7 +1310,8 @@ static inline void engine_make_hydro_loops_dependencies(struct scheduler *sched, ...@@ -1310,7 +1310,8 @@ static inline void engine_make_hydro_loops_dependencies(struct scheduler *sched,
* @brief Creates the dependency network for the stars tasks of a given cell. * @brief Creates the dependency network for the stars tasks of a given cell.
* *
* @param sched The #scheduler. * @param sched The #scheduler.
* @param density The density task to link. * @param density The star density task to link.
* @param feedback The star feedback task to link.
* @param c The cell. * @param c The cell.
*/ */
static inline void engine_make_stars_loops_dependencies(struct scheduler *sched, static inline void engine_make_stars_loops_dependencies(struct scheduler *sched,
......
...@@ -33,14 +33,16 @@ ...@@ -33,14 +33,16 @@
* *
* Nothing to do here in the EAGLE model. * Nothing to do here in the EAGLE model.
* *
* @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param with_cosmology Are we running a cosmological simulation?
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param time The current time.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
*/ */
static INLINE void tracers_after_init( static INLINE void tracers_after_init(
const struct part *p, struct xpart *xp, const struct unit_system *us, const struct part *p, struct xpart *xp, const struct unit_system *us,
...@@ -53,14 +55,16 @@ static INLINE void tracers_after_init( ...@@ -53,14 +55,16 @@ static INLINE void tracers_after_init(
* *
* Nothing to do here in the EAGLE model. * Nothing to do here in the EAGLE model.
* *
* @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param with_cosmology Are we running a cosmological simulation?
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param time The current time.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
*/ */
static INLINE void tracers_after_drift( static INLINE void tracers_after_drift(
const struct part *p, struct xpart *xp, const struct unit_system *us, const struct part *p, struct xpart *xp, const struct unit_system *us,
...@@ -74,14 +78,16 @@ static INLINE void tracers_after_drift( ...@@ -74,14 +78,16 @@ static INLINE void tracers_after_drift(
* *
* In EAGLE we record the highest temperature reached. * In EAGLE we record the highest temperature reached.
* *
* @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param with_cosmology Are we running a cosmological simulation?
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param time The current time.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
*/ */
static INLINE void tracers_after_timestep( static INLINE void tracers_after_timestep(
const struct part *p, struct xpart *xp, const struct unit_system *us, const struct part *p, struct xpart *xp, const struct unit_system *us,
...@@ -112,14 +118,14 @@ static INLINE void tracers_after_timestep( ...@@ -112,14 +118,14 @@ static INLINE void tracers_after_timestep(
* *
* Set the maximal temperature to a valid initial state * Set the maximal temperature to a valid initial state
* *
* @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers
* struct).
*/ */
static INLINE void tracers_first_init_xpart( static INLINE void tracers_first_init_xpart(
const struct part *p, struct xpart *xp, const struct unit_system *us, const struct part *p, struct xpart *xp, const struct unit_system *us,
......
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers * @param xp Pointer to the extended particle data (containing the tracers
...@@ -56,7 +56,7 @@ static INLINE void tracers_after_init( ...@@ -56,7 +56,7 @@ static INLINE void tracers_after_init(
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers * @param xp Pointer to the extended particle data (containing the tracers
...@@ -77,7 +77,7 @@ static INLINE void tracers_after_drift( ...@@ -77,7 +77,7 @@ static INLINE void tracers_after_drift(
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers * @param xp Pointer to the extended particle data (containing the tracers
...@@ -98,7 +98,7 @@ static INLINE void tracers_after_timestep( ...@@ -98,7 +98,7 @@ static INLINE void tracers_after_timestep(
* @param us The internal system of units. * @param us The internal system of units.
* @param phys_const The physical constants in internal units. * @param phys_const The physical constants in internal units.
* @param cosmo The current cosmological model. * @param cosmo The current cosmological model.
* @param hydro_properties the hydro_props struct * @param hydro_props the hydro_props struct
* @param cooling The #cooling_function_data used in the run. * @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data. * @param p Pointer to the particle data.
* @param xp Pointer to the extended particle data (containing the tracers * @param xp Pointer to the extended particle data (containing the tracers
......
Supports Markdown
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