Better documentation of the isothermal EoS.

0d30fc96 · Matthieu Schaller · 663491b8 · 0d30fc96
Commit 0d30fc96 authored May 02, 2018 by Matthieu Schaller
--- 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 */