From: Andre Noll <maan@systemlinux.org>
Date: Sun, 29 Dec 2013 16:26:24 +0000 (+0000)
Subject: Doxify error2.c and add GPL header.
X-Git-Tag: v0.5.2~6^2~15
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=63abcd1b2f6de6ce53d82962f5a2100c5a57e5d3;p=paraslash.git

Doxify error2.c and add GPL header.

Also add a link to the file in the doxygen main page.
---

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;
diff --git a/server.c b/server.c
index 70d9137e..fc7ff296 100644
--- a/server.c
+++ b/server.c
@@ -49,7 +49,7 @@
  *	- Spawning processes: \ref exec.c,
  *	- Inter process communication: \ref ipc.c,
  *	- Blob tables: \ref blob.c,
- *	- The error subsystem: \ref error.h.
+ *	- The error subsystem: \ref error.h, \ref error2.c,
  *	- Access control for paraslash senders: \ref acl.c, \ref acl.h.
  *	- Internal crypto API: \ref crypt.h.
  *	- interactive sessions (libreadline): \ref interactive.c.