From 19a99afbba1ec324222f5bc33ed70ebf5f01e8d3 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Thu, 30 Jun 2016 13:30:06 +0100
Subject: [PATCH] Documentation fixes
---
src/debug.c | 3 +--
src/part.c | 6 +++---
2 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/src/debug.c b/src/debug.c
index 3356302e67..e7b60c52f9 100644
--- a/src/debug.c
+++ b/src/debug.c
@@ -59,7 +59,6 @@
*
* (Should be used for debugging only as it runs in O(N).)
*/
-
void printParticle(const struct part *parts, struct xpart *xparts,
long long int id, size_t N) {
@@ -83,6 +82,7 @@ void printParticle(const struct part *parts, struct xpart *xparts,
* the standard output.
*
* @param gparts The array of g-particles.
+ * @param parts The array of particles.
* @param id The id too look for.
* @param N The size of the array of g-particles.
*
@@ -117,7 +117,6 @@ void printgParticle(const struct gpart *gparts, const struct part *parts,
* @param p The particle to print
* @param xp The extended data ot the particle to print
*/
-
void printParticle_single(const struct part *p, const struct xpart *xp) {
printf("## Particle: id=%lld", p->id);
diff --git a/src/part.c b/src/part.c
index 7634040adc..b00eaccaae 100644
--- a/src/part.c
+++ b/src/part.c
@@ -30,11 +30,11 @@
#include "part.h"
/**
- * @brief Re-link the #gparts associated with the list of #parts.
+ * @brief Re-link the #gpart%s associated with the list of #part%s.
*
* @param parts The list of #part.
* @param N The number of particles to re-link;
- * @param offset The offset of #parts relative to the global parts list.
+ * @param offset The offset of #part%s relative to the global parts list.
*/
void part_relink_gparts(struct part *parts, size_t N, ptrdiff_t offset) {
for (size_t k = 0; k < N; k++) {
@@ -45,7 +45,7 @@ void part_relink_gparts(struct part *parts, size_t N, ptrdiff_t offset) {
}
/**
- * @brief Re-link the #gparts associated with the list of #parts.
+ * @brief Re-link the #gpart%s associated with the list of #part%s.
*
* @param gparts The list of #gpart.
* @param N The number of particles to re-link;
--
GitLab