From d4421028bbd0412f178496e1b01959c740d954bb Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Mon, 10 Dec 2018 10:03:49 +0000
Subject: [PATCH] Documentation fixes.
---
src/cooling/Compton/cooling.h | 3 +--
src/cooling/EAGLE/cooling_tables.c | 2 +-
src/cooling/const_du/cooling.h | 3 +--
src/cooling/const_lambda/cooling.h | 3 +--
src/cooling/grackle/cooling.h | 3 +--
5 files changed, 5 insertions(+), 9 deletions(-)
diff --git a/src/cooling/Compton/cooling.h b/src/cooling/Compton/cooling.h
index 632e6e07b6..f440cd0345 100644
--- a/src/cooling/Compton/cooling.h
+++ b/src/cooling/Compton/cooling.h
@@ -39,10 +39,9 @@
* @brief Common operations performed on the cooling function at a
* given time-step or redshift.
*
- * @param phys_const The physical constants in internal units.
- * @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param cooling The #cooling_function_data used in the run.
+ * @param restart_flag Are we calling this directly after a restart?
*/
INLINE static void cooling_update(const struct cosmology* cosmo,
struct cooling_function_data* cooling,
diff --git a/src/cooling/EAGLE/cooling_tables.c b/src/cooling/EAGLE/cooling_tables.c
index 1da1f1c014..4f3aed0574 100644
--- a/src/cooling/EAGLE/cooling_tables.c
+++ b/src/cooling/EAGLE/cooling_tables.c
@@ -18,7 +18,7 @@
******************************************************************************/
/**
- * @file src/cooling/EAGLE/eagle_cool_tables.c
+ * @file src/cooling/EAGLE/cooling_tables.c
* @brief Functions to read EAGLE tables
*/
diff --git a/src/cooling/const_du/cooling.h b/src/cooling/const_du/cooling.h
index eb9b098105..dac92f0983 100644
--- a/src/cooling/const_du/cooling.h
+++ b/src/cooling/const_du/cooling.h
@@ -49,10 +49,9 @@
* @brief Common operations performed on the cooling function at a
* given time-step or redshift.
*
- * @param phys_const The physical constants in internal units.
- * @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param cooling The #cooling_function_data used in the run.
+ * @param restart_flag Are we calling this directly after a restart?
*/
INLINE static void cooling_update(const struct cosmology* cosmo,
struct cooling_function_data* cooling,
diff --git a/src/cooling/const_lambda/cooling.h b/src/cooling/const_lambda/cooling.h
index eef62330ae..3c336060bd 100644
--- a/src/cooling/const_lambda/cooling.h
+++ b/src/cooling/const_lambda/cooling.h
@@ -48,10 +48,9 @@
* @brief Common operations performed on the cooling function at a
* given time-step or redshift.
*
- * @param phys_const The physical constants in internal units.
- * @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param cooling The #cooling_function_data used in the run.
+ * @param restart_flag Are we calling this directly after a restart?
*/
INLINE static void cooling_update(const struct cosmology* cosmo,
struct cooling_function_data* cooling,
diff --git a/src/cooling/grackle/cooling.h b/src/cooling/grackle/cooling.h
index ce71a37065..03f3f1f14d 100644
--- a/src/cooling/grackle/cooling.h
+++ b/src/cooling/grackle/cooling.h
@@ -52,10 +52,9 @@
* @brief Common operations performed on the cooling function at a
* given time-step or redshift.
*
- * @param phys_const The physical constants in internal units.
- * @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param cooling The #cooling_function_data used in the run.
+ * @param restart_flag Are we calling this directly after a restart?
*/
INLINE static void cooling_update(const struct cosmology* cosmo,
struct cooling_function_data* cooling,
--
GitLab