From: Andre Noll <maan@systemlinux.org>
Date: Tue, 11 Nov 2008 22:39:06 +0000 (+0100)
Subject: Start writing the mainpage for the API reference.
X-Git-Tag: v0.1.0~27
X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=commitdiff_plain;h=6928432da745f3dadea85855bbc3be3012ea6f7c;ds=sidebyside

Start writing the mainpage for the API reference.

This should also contain a general overview..
---

diff --git a/adu.c b/adu.c
index cd77fd9..f907cf4 100644
--- a/adu.c
+++ b/adu.c
@@ -5,6 +5,17 @@
  */
 
 /** \file adu.c \brief The main functions used by all modes of operation. */
+
+/**
+ * \mainpage adu API reference
+ *
+ * - Modes of operation: \ref select.c, \ref create.c, \ref interactive.c
+ * - User handling: \ref user.c
+ * - Error handling: \ref error.h
+ * - Library-type functions: \ref fd.c, \ref format.c, \ref string.c, \ref portable_io.h
+ * - Generated files: \ref cmdline.h, \ref select.cmdline.h
+ */
+
 #include "adu.h"
 #include <dirent.h> /* readdir() */
 #include <pwd.h>