Add more source code documentation.

[adu.git] / interactive.c

diff --git a/interactive.c b/interactive.c
index 288e9f3031f2890f73282a67ebd04be5bdffe142..b3254157d6785403573252876624c026ed912ed4 100644 (file)
--- a/interactive.c
+++ b/interactive.c
@@ -7,9 +7,18 @@
 #include "error.h"
 #include "cmdline.h"
 
+/**
+ * Describes one valid command for interactive mode.
+ *
+ * When invoked in interactive mode, adu reads commands from stdin. There's a
+ * static array of all such commands.
+ */
 struct interactive_command {
+       /** The name of the command. */
        const char *name;
+       /** Pointer to The function that is being executed. */
        int (*handler)(char *);
+       /** Help text. */
        const char *desc;
 };