Merge branch 'master' into aac

[paraslash.git] / file_writer.c

diff --git a/file_writer.c b/file_writer.c
index 7878cce1e5612074d112726637fe8345cba17acb..a7a765e1175c6379e1881973faa9553255a3cd40 100644 (file)
--- a/file_writer.c
+++ b/file_writer.c
@@ -16,14 +16,19 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file file_writer.c simple output plugin for testing purposes */
+
 #include "para.h"
 #include "write.h"
 #include "string.h"
 #include "error.h"
 
+/** data specific to the file writer */
 struct private_file_writer_data {
-       int fd;
+/** the file descriptor of the output file */
+int fd;
 };
+
 static int file_writer_open(struct writer_node *w)
 {
        struct private_file_writer_data *pfwd = para_calloc(
@@ -58,6 +63,7 @@ static void file_writer_close(struct writer_node *wn)
        free(pfwd);
 }
 
+/** the init function of the file writer */
 void file_writer_init(struct writer *w)
 {
        w->open = file_writer_open;