X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=error2.c;h=9271dadf8a6424e86ccdc7ae3ff5e504b93e0155;hp=630d4c7195416ff54f217521ead604200925e32f;hb=63abcd1b2f6de6ce53d82962f5a2100c5a57e5d3;hpb=cf517575ef0e501c963964ba4fd62aadaf795af8

diff --git a/error2.c b/error2.c
index 630d4c71..9271dadf 100644
--- a/error2.c
+++ b/error2.c
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 2013-2014 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file error2.c Simple program to create error2.h. */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <assert.h>
@@ -135,6 +143,18 @@ static void dump_bipolar(void)
 	}
 }
 
+/**
+ * The main function of error2.c.
+ *
+ * The purpose of this program is to create the error2.h file which defines the
+ * enumerations of all error codes which may be used by any given .c file. This
+ * header is included by most .c files of the paraslash suite.
+ *
+ * Since this program is executed on the build system, it must be compiled with
+ * the host compiler.
+ *
+ * \return \p EXIT_SUCCESS or \p EXIT_FAILURE.
+ */
 int main(void)
 {
 	int ret;