Add htacess and icons for fancy indexing.

[paraslash.git] / error2.c

diff --git a/error2.c b/error2.c
index 630d4c7195416ff54f217521ead604200925e32f..189a2962e73f61ec47405c47147c8d9e4e256695 100644 (file)
--- a/error2.c
+++ b/error2.c
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 2013-2014 Andre Noll <maan@tuebingen.mpg.de>
+ *
+ * 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;