From e872b4b833e443f55ebfbd3597b040b8731b9c5a Mon Sep 17 00:00:00 2001
From: "Peter W. Draper" <p.w.draper@durham.ac.uk>
Date: Thu, 4 Aug 2016 16:11:58 +0100
Subject: [PATCH] Fix up some minor documentation problems
---
src/engine.c | 8 ++++++--
src/runner.c | 2 +-
src/scheduler.c | 7 +++++--
3 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/src/engine.c b/src/engine.c
index a43baa8906..58c7092800 100644
--- a/src/engine.c
+++ b/src/engine.c
@@ -1306,7 +1306,9 @@ void engine_make_hydroloop_tasks(struct engine *e) {
* For each hydrodynamic task, construct the links with the corresponding cell.
* Similarly, construct the dependencies for all the sorting tasks.
*
- * @param e The #engine.
+ * @param map_data The #engine.
+ * @param num_elements Number of tasks to process.
+ * @param extra_data Pointer to the tasks.
*/
void engine_count_and_link_tasks_mapper(void *map_data, int num_elements,
@@ -1560,7 +1562,9 @@ static inline void engine_make_hydro_loops_dependencies(struct scheduler *sched,
* This function is a mapper function to be used via the #threadpool_map
* function.
*
- * @param e The #engine.
+ * @param map_data The #engine.
+ * @param num_elements Number of tasks to process.
+ * @param extra_data Pointer to the tasks.
*/
void engine_make_extra_hydroloop_tasks_mapper(void *map_data, int num_elements,
void *extra_data) {
diff --git a/src/runner.c b/src/runner.c
index 6b0f6aa21f..99d007f40f 100644
--- a/src/runner.c
+++ b/src/runner.c
@@ -586,7 +586,7 @@ void runner_do_ghost(struct runner *r, struct cell *c) {
/**
* @brief Mapper function to drift particles and g-particles forward in time.
*
- * @param map_data An array of #cells.
+ * @param map_data An array of #cell%s.
* @param num_elements Chunk size.
* @param extra_data Pointer to an #engine.
*/
diff --git a/src/scheduler.c b/src/scheduler.c
index a2e3b57c8f..c8cae07b39 100644
--- a/src/scheduler.c
+++ b/src/scheduler.c
@@ -101,9 +101,11 @@ void scheduler_addunlock(struct scheduler *s, struct task *ta,
}
/**
- * @brief Split tasks that may be too large.
+ * @brief Mapper function to split tasks that may be too large.
*
- * @param s The #scheduler we are working in.
+ * @param map_data the tasks to process
+ * @param num_elements the number of tasks.
+ * @param extra_data The #scheduler we are working in.
*/
void scheduler_splittasks_mapper(void *map_data, int num_elements,
@@ -1340,6 +1342,7 @@ struct task *scheduler_gettask(struct scheduler *s, int qid,
* @param nr_queues The number of queues in this scheduler.
* @param flags The #scheduler flags.
* @param nodeID The MPI rank
+ * @param tp Parallel processing threadpool.
*/
void scheduler_init(struct scheduler *s, struct space *space, int nr_tasks,
--
GitLab