From c862c83f1fcd4925c96f4f634e5ffcb1c4676443 Mon Sep 17 00:00:00 2001
From: hasufell <hasufell@hasufell.de>
Date: Mon, 26 May 2014 21:39:10 +0200
Subject: [PATCH] FILE: fix/add doxygen comments

---
 src/file.c | 2 +-
 src/file.h | 7 +++++++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/file.c b/src/file.c
index 94706a1..0e9ddf7 100644
--- a/src/file.c
+++ b/src/file.c
@@ -21,7 +21,7 @@
 
 /**
  * @file file.c
- * Allows operations of files, such as reading
+ * Allows operations on files, such as reading
  * and writing.
  * @brief file operations
  */
diff --git a/src/file.h b/src/file.h
index 335b5f7..b5cffce 100644
--- a/src/file.h
+++ b/src/file.h
@@ -42,6 +42,13 @@
 string *
 read_file(char const * const filename);
 
+/**
+ * Write a string to a file. The file will be pruned or created
+ * if it does not exist.
+ *
+ * @param wstring the string to write to the file
+ * @param filename the name of the file to write to
+ */
 void
 write_file(string const *wstring, char const * const filename);