+/*
+ * Copyright (C) 2013 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>
-#include <assert.h>
#include <inttypes.h>
#include <string.h>
#include <stdbool.h>
-#include <stdbool.h>
#include <errno.h>
#include <ctype.h>
}
}
+/**
+ * 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;