Doxify error2.c and add GPL header.
authorAndre Noll <maan@systemlinux.org>
Sun, 29 Dec 2013 16:26:24 +0000 (16:26 +0000)
committerAndre Noll <maan@systemlinux.org>
Sat, 22 Feb 2014 15:49:30 +0000 (16:49 +0100)
Also add a link to the file in the doxygen main page.

error2.c
server.c

index 630d4c7..9271dad 100644 (file)
--- 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;
index 70d9137..fc7ff29 100644 (file)
--- 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.