From 601b7d0ebdaec8a031fb2721b0bccf42e43a5a32 Mon Sep 17 00:00:00 2001 From: Matthieu Schaller <matthieu.schaller@durham.ac.uk> Date: Mon, 6 Feb 2017 12:00:51 +0000 Subject: [PATCH] Documentation --- src/stars/Default/star_part.h | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/src/stars/Default/star_part.h b/src/stars/Default/star_part.h index 465c88caaa..e958e3d68b 100644 --- a/src/stars/Default/star_part.h +++ b/src/stars/Default/star_part.h @@ -22,25 +22,29 @@ /* Some standard headers. */ #include <stdlib.h> -/* Star particle. */ +/** + * @brief Particle fields for the star particles. + * + * All quantities related to gravity are stored in the associate #gpart. + */ struct spart { - /* Particle ID. */ + /*! Particle ID. */ long long id; - /* Pointer to corresponding gravity part. */ + /*! Pointer to corresponding gravity part. */ struct gpart* gpart; - /* Particle position. */ + /*! Particle position. */ double x[3]; - /* Particle velocity. */ + /*! Particle velocity. */ float v[3]; - /* Star mass */ + /*! Star mass */ float mass; - /* Particle time bin */ + /*! Particle time bin */ timebin_t time_bin; } SWIFT_STRUCT_ALIGN; -- GitLab