From 1dc4b908be81a59a185db486b66c64715a2ce622 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Sat, 16 Dec 2017 08:55:38 +0000
Subject: [PATCH] Documentation of the new i/o function parameters.

---
 src/common_io.c   | 2 ++
 src/parallel_io.c | 1 +
 src/serial_io.c   | 1 +
 3 files changed, 4 insertions(+)

diff --git a/src/common_io.c b/src/common_io.c
index aecd0da609..7d0b0cb3ef 100644
--- a/src/common_io.c
+++ b/src/common_io.c
@@ -692,6 +692,7 @@ void io_duplicate_hydro_gparts_mapper(void* restrict data, int Ngas,
  * This function assumes that the DM particles are all at the start of the
  * gparts array and adds the hydro particles afterwards
  *
+ * @param tp The current #threadpool.
  * @param parts The array of #part freshly read in.
  * @param gparts The array of #gpart freshly read in with all the DM particles
  * at the start
@@ -747,6 +748,7 @@ void io_duplicate_hydro_sparts_mapper(void* restrict data, int Nstars,
  * This function assumes that the DM particles and gas particles are all at
  * the start of the gparts array and adds the star particles afterwards
  *
+ * @param tp The current #threadpool.
  * @param sparts The array of #spart freshly read in.
  * @param gparts The array of #gpart freshly read in with all the DM and gas
  * particles at the start.
diff --git a/src/parallel_io.c b/src/parallel_io.c
index d7613aff5f..0711cc1d8e 100644
--- a/src/parallel_io.c
+++ b/src/parallel_io.c
@@ -530,6 +530,7 @@ void writeArray(struct engine* e, hid_t grp, char* fileName, FILE* xmfFile,
  * @param mpi_size The number of MPI ranks
  * @param comm The MPI communicator
  * @param info The MPI information object
+ * @param n_threads The number of threads to use for local operations.
  * @param dry_run If 1, don't read the particle. Only allocates the arrays.
  *
  */
diff --git a/src/serial_io.c b/src/serial_io.c
index 81406482c6..7f87c0183d 100644
--- a/src/serial_io.c
+++ b/src/serial_io.c
@@ -380,6 +380,7 @@ void writeArray(const struct engine* e, hid_t grp, char* fileName,
  * @param mpi_size The number of MPI ranks
  * @param comm The MPI communicator
  * @param info The MPI information object
+ * @param n_threads The number of threads to use for local operations.
  * @param dry_run If 1, don't read the particle. Only allocates the arrays.
  *
  * Opens the HDF5 file fileName and reads the particles contained
-- 
GitLab