From a09f2c4a76126496a57fc83213562c75b74a9da1 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Sun, 29 Sep 2013 16:47:16 +0000
Subject: [PATCH] Corrected a few doxygen comments of the last few revisions.
Former-commit-id: a0b7a5c53e14c56c130e8290b7fa7db3132ddfd4
---
src/common_io.c | 1 +
src/serial_io.c | 3 +++
2 files changed, 4 insertions(+)
diff --git a/src/common_io.c b/src/common_io.c
index 0316ca0a14..0b6130e3de 100644
--- a/src/common_io.c
+++ b/src/common_io.c
@@ -317,6 +317,7 @@ void writeSPHflavour(hid_t h_file)
/**
* @brief Writes the current Unit System
* @param h_file The (opened) HDF5 file in which to write
+ * @param us The UnitSystem used in the run
*/
void writeUnitSystem(hid_t h_file, struct UnitSystem* us)
{
diff --git a/src/serial_io.c b/src/serial_io.c
index 9601f7e892..4c38a3e9c5 100644
--- a/src/serial_io.c
+++ b/src/serial_io.c
@@ -271,6 +271,8 @@ void read_ic ( char* fileName, double dim[3], struct part **parts, int* N, int*
* @param N The number of particles to write.
* @param dim The dimension of the data (1 for scalar, 3 for vector)
* @param part_c A (char*) pointer on the first occurence of the field of interest in the parts array
+ * @param us The UnitSystem currently in use
+ * @param convFactor The UnitConversionFactor for this array
*
* @todo A better version using HDF5 hyperslabs to write the file directly from the part array
* will be written once the strucutres have been stabilized.
@@ -378,6 +380,7 @@ void writeArrayBackEnd(hid_t grp, char* fileName, FILE* xmfFile, char* name, enu
* @brief Writes an HDF5 output file (GADGET-3 type) with its XMF descriptor
*
* @param e The engine containing all the system.
+ * @param us The UnitSystem used for the conversion of units in the output
*
* Creates an HDF5 output file and writes the particles contained
* in the engine. If such a file already exists, it is erased and replaced
--
GitLab