From b3421a968328839a6eeac1b005deaa36ff064634 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Sun, 16 Dec 2018 13:17:41 +0000
Subject: [PATCH] Documentation fixes

---
 src/engine_maketasks.c      |  3 ++-
 src/tracers/EAGLE/tracers.h | 38 +++++++++++++++++++++----------------
 src/tracers/none/tracers.h  |  8 ++++----
 3 files changed, 28 insertions(+), 21 deletions(-)

diff --git a/src/engine_maketasks.c b/src/engine_maketasks.c
index 7d77e8c6c7..f280c2a610 100644
--- a/src/engine_maketasks.c
+++ b/src/engine_maketasks.c
@@ -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.
  *
  * @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.
  */
 static inline void engine_make_stars_loops_dependencies(struct scheduler *sched,
diff --git a/src/tracers/EAGLE/tracers.h b/src/tracers/EAGLE/tracers.h
index ed3e12f9de..706a8ad991 100644
--- a/src/tracers/EAGLE/tracers.h
+++ b/src/tracers/EAGLE/tracers.h
@@ -33,14 +33,16 @@
  *
  * 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 phys_const The physical constants in internal units.
+ * @param with_cosmology Are we running a cosmological simulation?
  * @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 p Pointer to the particle data.
- * @param xp Pointer to the extended particle data (containing the tracers
- * struct).
+ * @param time The current time.
  */
 static INLINE void tracers_after_init(
     const struct part *p, struct xpart *xp, const struct unit_system *us,
@@ -53,14 +55,16 @@ static INLINE void tracers_after_init(
  *
  * 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 phys_const The physical constants in internal units.
+ * @param with_cosmology Are we running a cosmological simulation?
  * @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 p Pointer to the particle data.
- * @param xp Pointer to the extended particle data (containing the tracers
- * struct).
+ * @param time The current time.
  */
 static INLINE void tracers_after_drift(
     const struct part *p, struct xpart *xp, const struct unit_system *us,
@@ -74,14 +78,16 @@ static INLINE void tracers_after_drift(
  *
  * 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 phys_const The physical constants in internal units.
+ * @param with_cosmology Are we running a cosmological simulation?
  * @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 p Pointer to the particle data.
- * @param xp Pointer to the extended particle data (containing the tracers
- * struct).
+ * @param time The current time.
  */
 static INLINE void tracers_after_timestep(
     const struct part *p, struct xpart *xp, const struct unit_system *us,
@@ -112,14 +118,14 @@ static INLINE void tracers_after_timestep(
  *
  * 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 phys_const The physical constants in internal units.
  * @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 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(
     const struct part *p, struct xpart *xp, const struct unit_system *us,
diff --git a/src/tracers/none/tracers.h b/src/tracers/none/tracers.h
index f3f55e8283..4cf2fb4ad4 100644
--- a/src/tracers/none/tracers.h
+++ b/src/tracers/none/tracers.h
@@ -36,7 +36,7 @@
  * @param us The internal system of units.
  * @param phys_const The physical constants in internal units.
  * @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 p Pointer to the particle data.
  * @param xp Pointer to the extended particle data (containing the tracers
@@ -56,7 +56,7 @@ static INLINE void tracers_after_init(
  * @param us The internal system of units.
  * @param phys_const The physical constants in internal units.
  * @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 p Pointer to the particle data.
  * @param xp Pointer to the extended particle data (containing the tracers
@@ -77,7 +77,7 @@ static INLINE void tracers_after_drift(
  * @param us The internal system of units.
  * @param phys_const The physical constants in internal units.
  * @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 p Pointer to the particle data.
  * @param xp Pointer to the extended particle data (containing the tracers
@@ -98,7 +98,7 @@ static INLINE void tracers_after_timestep(
  * @param us The internal system of units.
  * @param phys_const The physical constants in internal units.
  * @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 p Pointer to the particle data.
  * @param xp Pointer to the extended particle data (containing the tracers
-- 
GitLab