From d322fa64e7bc4dae9379a51e01d615b5fa978518 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Thu, 29 Oct 2020 09:46:53 +0100
Subject: [PATCH] Better documentation strings
---
src/black_holes/EAGLE/black_holes_properties.h | 8 ++++++++
src/feedback/EAGLE/feedback_properties.h | 7 +++++++
2 files changed, 15 insertions(+)
diff --git a/src/black_holes/EAGLE/black_holes_properties.h b/src/black_holes/EAGLE/black_holes_properties.h
index 6f20ec1884..5f86bedf34 100644
--- a/src/black_holes/EAGLE/black_holes_properties.h
+++ b/src/black_holes/EAGLE/black_holes_properties.h
@@ -19,11 +19,19 @@
#ifndef SWIFT_EAGLE_BLACK_HOLES_PROPERTIES_H
#define SWIFT_EAGLE_BLACK_HOLES_PROPERTIES_H
+/* Config parameters. */
+#include "../config.h"
+
+/* Local includes. */
#include "chemistry.h"
#include "hydro_properties.h"
+/* Includes. */
#include <string.h>
+/**
+ * @brief Modes of energy injection for AGN feedback
+ */
enum AGN_feedback_models {
AGN_random_ngb_model, /*< Random neighbour model for AGN feedback */
AGN_isotropic_model, /*< Isotropic model of AGN feedback */
diff --git a/src/feedback/EAGLE/feedback_properties.h b/src/feedback/EAGLE/feedback_properties.h
index db81b4fc4e..83db5e1114 100644
--- a/src/feedback/EAGLE/feedback_properties.h
+++ b/src/feedback/EAGLE/feedback_properties.h
@@ -19,9 +19,16 @@
#ifndef SWIFT_EAGLE_FEEDBACK_PROPERTIES_H
#define SWIFT_EAGLE_FEEDBACK_PROPERTIES_H
+/* Config parameters. */
+#include "../config.h"
+
+/* Local includes. */
#include "chemistry.h"
#include "hydro_properties.h"
+/**
+ * @brief Modes of energy injection for SNII feedback
+ */
enum SNII_feedback_models {
SNII_random_ngb_model, /*< Random neighbour model for SNII feedback */
SNII_isotropic_model, /*< Isotropic model of SNII feedback */
--
GitLab