From 0d30fc96459c423ee46e3650360c4594b195952f Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Wed, 2 May 2018 21:19:02 +0200
Subject: [PATCH] Better documentation of the isothermal EoS.
---
src/equation_of_state/isothermal/equation_of_state.h | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/equation_of_state/isothermal/equation_of_state.h b/src/equation_of_state/isothermal/equation_of_state.h
index c798c08b0d..c7afac6caa 100644
--- a/src/equation_of_state/isothermal/equation_of_state.h
+++ b/src/equation_of_state/isothermal/equation_of_state.h
@@ -29,8 +29,10 @@
#include "physical_constants.h"
extern struct eos_parameters eos;
-/* ------------------------------------------------------------------------- */
+/**
+ * @brief The parameters of the equation of state for the gas.
+ */
struct eos_parameters {
/*! Thermal energy per unit mass */
--
GitLab