Some more source code documentation.

[adu.git] / adu.c

diff --git a/adu.c b/adu.c
index cd77fd9f9f4741b7c9f805072737bc4216f1f36e..dd74ca46f4932ec39a89d070092eb4705f5cbfe5 100644 (file)
--- a/adu.c
+++ b/adu.c
@@ -5,6 +5,16 @@
  */
 
 /** \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
+ */
+
 #include "adu.h"
 #include <dirent.h> /* readdir() */
 #include <pwd.h>
@@ -17,10 +27,11 @@
 #include "string.h"
 #include "error.h"
 
+/** Define the array of error descriptions. */
 DEFINE_ERRLIST;
 
 /**
- * The error code of the last osl library function.
+ * The error code of the last called osl library function.
  *
  * \sa osl().
  */