From 383ec6d997bec099dbd2965de1d946d0f72cf4f4 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Sat, 19 May 2018 14:33:25 +0200
Subject: [PATCH] Documentation fixes and code formatting.
---
examples/main.c | 3 ++-
src/equation_of_state.h | 2 +-
src/equation_of_state/ideal_gas/equation_of_state.h | 2 +-
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/examples/main.c b/examples/main.c
index 5df2893d16..4d59e97445 100644
--- a/examples/main.c
+++ b/examples/main.c
@@ -674,7 +674,8 @@ int main(int argc, char *argv[]) {
#ifndef HAVE_FFTW
/* Need the FFTW library if periodic and self gravity. */
if (with_self_gravity && periodic)
- error("No FFTW library found. Cannot compute periodic long-range forces.");
+ error(
+ "No FFTW library found. Cannot compute periodic long-range forces.");
#endif
#ifdef SWIFT_DEBUG_CHECKS
diff --git a/src/equation_of_state.h b/src/equation_of_state.h
index 1fed652f35..d170ce1a7c 100644
--- a/src/equation_of_state.h
+++ b/src/equation_of_state.h
@@ -20,7 +20,7 @@
#define SWIFT_EQUATION_OF_STATE_H
/**
- * @file equation_of_state.h
+ * @file src/equation_of_state.h
* @brief Defines the equation of state of the gas we simulate in the form of
* relations between thermodynamic quantities. These are later used internally
* by all hydro schemes
diff --git a/src/equation_of_state/ideal_gas/equation_of_state.h b/src/equation_of_state/ideal_gas/equation_of_state.h
index 4d873fbfbb..36b3511558 100644
--- a/src/equation_of_state/ideal_gas/equation_of_state.h
+++ b/src/equation_of_state/ideal_gas/equation_of_state.h
@@ -171,7 +171,7 @@ __attribute__((always_inline)) INLINE static float gas_soundspeed_from_pressure(
*
* Nothing to do here since this EoS is parameter-free.
*
- * @param e The #eos_paramters.
+ * @param e The #eos_parameters.
* @param phys_const The physical constants in the internal unit system.
* @param us The internal unit system.
* @param params The parsed parameters.
--
GitLab