From c6c032b52236201acff36ed98332c56b50dc4437 Mon Sep 17 00:00:00 2001
From: James Willis <james.s.willis@durham.ac.uk>
Date: Tue, 29 Mar 2016 12:24:27 +0100
Subject: [PATCH] Added doxygen documentation to parser_write_params_to_file

---
 src/parser.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/parser.c b/src/parser.c
index 936167cc28..b332e31b53 100644
--- a/src/parser.c
+++ b/src/parser.c
@@ -254,6 +254,14 @@ void parser_print_params(struct swift_params *params) {
 
 }
 
+/** 
+ * @brief Write the contents of the parameter structure to a file in YAML format.
+ *
+ * @param params Structure that holds the parameters
+ * @param file_name Name of file to be written
+ *
+ */
+
 void parser_write_params_to_file(struct swift_params *params, const char *file_name) {
 
     FILE *file = fopen(file_name, "w");
-- 
GitLab