]> git.tue.mpg.de Git - adu.git/commitdiff
Start writing the mainpage for the API reference.
authorAndre Noll <maan@systemlinux.org>
Tue, 11 Nov 2008 22:39:06 +0000 (23:39 +0100)
committerAndre Noll <maan@systemlinux.org>
Tue, 11 Nov 2008 22:39:06 +0000 (23:39 +0100)
This should also contain a general overview..

adu.c

diff --git a/adu.c b/adu.c
index cd77fd9f9f4741b7c9f805072737bc4216f1f36e..f907cf476a9cf7a062623488bb4f8afbc5d29173 100644 (file)
--- 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>