From d3566eca544448fe0c5c0c69cc30fb3d426ee3fe Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Tue, 7 Jul 2020 17:33:24 +0200
Subject: [PATCH] Fixes to the doxygen documentation
---
doc/Doxyfile.in | 1 +
src/cooling/COLIBRE/cooling.c | 11 ++++++-----
src/cooling/COLIBRE/cooling_rates.h | 5 ++---
src/cooling/COLIBRE/cooling_tables.c | 1 -
src/task.c | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 646f5951a4..afe7b52f1e 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -770,6 +770,7 @@ INPUT += @top_srcdir@/src/cooling/const_du
INPUT += @top_srcdir@/src/cooling/const_lambda
INPUT += @top_srcdir@/src/cooling/Compton
INPUT += @top_srcdir@/src/cooling/EAGLE
+INPUT += @top_srcdir@/src/cooling/COLIBRE
INPUT += @top_srcdir@/src/cooling/grackle
INPUT += @top_srcdir@/src/chemistry/EAGLE
INPUT += @top_srcdir@/src/chemistry/GEAR
diff --git a/src/cooling/COLIBRE/cooling.c b/src/cooling/COLIBRE/cooling.c
index 5a95263a40..0a224fc8f8 100644
--- a/src/cooling/COLIBRE/cooling.c
+++ b/src/cooling/COLIBRE/cooling.c
@@ -647,6 +647,7 @@ __attribute__((always_inline)) INLINE float cooling_timestep(
*
* @param phys_const #phys_const data structure.
* @param us The internal system of units.
+ * @param hydro_props The properties of the hydro scheme.
* @param cosmo #cosmology data structure.
* @param cooling #cooling_function_data struct.
* @param p #part data.
@@ -935,7 +936,6 @@ float cooling_get_subgrid_density(
* @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param hydro_props the hydro_props struct
- * @param starform the star formation law properties to initialize
* @param floor_props Properties of the entropy floor.
* @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data.
@@ -1044,10 +1044,11 @@ void cooling_Hydrogen_reionization(const struct cooling_function_data *cooling,
/**
* @brief Initialises properties stored in the cooling_function_data struct
*
- * @param parameter_file The parsed parameter file
- * @param us Internal system of units data structure
- * @param phys_const #phys_const data structure
- * @param cooling #cooling_function_data struct to initialize
+ * @param parameter_file The parsed parameter file.
+ * @param us Internal system of units data structure.
+ * @param hydro_props the properties of the hydro scheme.
+ * @param phys_const #phys_const data structure.
+ * @param cooling #cooling_function_data struct to initialize.
*/
void cooling_init_backend(struct swift_params *parameter_file,
const struct unit_system *us,
diff --git a/src/cooling/COLIBRE/cooling_rates.h b/src/cooling/COLIBRE/cooling_rates.h
index cf38391cf4..a6bbc5b6f3 100644
--- a/src/cooling/COLIBRE/cooling_rates.h
+++ b/src/cooling/COLIBRE/cooling_rates.h
@@ -410,7 +410,6 @@ __attribute__((always_inline)) INLINE static float colibre_convert_temp_to_u(
* @param redshift Current redshift
* @param n_H_cgs Hydrogen number density in cgs
* @param ZZsol Metallicity relative to the solar value from the tables
- * @param abundance_ratio Abundance ratio for each element x relative to solar
* @param n_H_index Index along the Hydrogen number density dimension
* @param d_n_H Offset between Hydrogen density and table[n_H_index]
* @param met_index Index along the metallicity dimension
@@ -458,7 +457,7 @@ INLINE static float colibre_meanparticlemass_temperature(
* @param d_red Offset between redshift and table[red_index]
* @param cooling #cooling_function_data structure
*
- * @retura linear electron density in cm-3 (NOT the electron fraction)
+ * @return linear electron density in cm-3 (NOT the electron fraction)
*/
INLINE static float colibre_electron_density(
double log_u_cgs, double redshift, double n_H_cgs, float ZZsol,
@@ -501,7 +500,7 @@ INLINE static float colibre_electron_density(
* @param d_red Offset between redshift and table[red_index]
* @param cooling #cooling_function_data structure
*
- * @retura linear electron density in cm-3 (NOT the electron fraction)
+ * @return linear electron density in cm-3 (NOT the electron fraction)
*/
INLINE static float colibre_electron_density_temperature(
double log_T_cgs, double redshift, double n_H_cgs, float ZZsol,
diff --git a/src/cooling/COLIBRE/cooling_tables.c b/src/cooling/COLIBRE/cooling_tables.c
index fb9c2bcabd..e3cdc2f8dd 100644
--- a/src/cooling/COLIBRE/cooling_tables.c
+++ b/src/cooling/COLIBRE/cooling_tables.c
@@ -46,7 +46,6 @@
* of values for temperature, hydrogen number density, metallicity,
* abundance ratios, and elements used to index the cooling tables.
*
- * @param fname Filepath for cooling table from which to read header
* @param cooling Cooling data structure
*/
void read_cooling_header(struct cooling_function_data *cooling) {
diff --git a/src/task.c b/src/task.c
index 09721bcd88..a766d5b363 100644
--- a/src/task.c
+++ b/src/task.c
@@ -1097,7 +1097,7 @@ void task_dump_all(struct engine *e, int step) {
*
* @param dumpfile name of the file for the output.
* @param e the #engine
- * @param dump_task_threshold Fraction of the step time above whic any task
+ * @param dump_tasks_threshold Fraction of the step time above whic any task
* triggers a call to task_dump_all().
* @param header whether to write a header include file.
* @param allranks do the statistics over all ranks, if not just the current
--
GitLab