Document takes_argument_t and its members.

diff --git a/src/app/config/config.c b/src/app/config/config.c
index 561fc654565a45458c87e640f9e8801f63a76626..44d6a82e56dac5993ea72dd70276716097f8748f 100644 (file)
--- a/src/app/config/config.c
+++ b/src/app/config/config.c
@@ -2447,9 +2447,15 @@ options_act(const or_options_t *old_options)
   return 0;
 }
 
+/**
+ * Enumeration to describe the syntax for a command-line option.
+ **/
 typedef enum {
+  /** Describe an option that does not take an argument. */
   ARGUMENT_NONE = 0,
+  /** Describes an option that takes a single argument. */
   ARGUMENT_NECESSARY = 1,
+  /** Describes an option that takes a single optinal argument. */
   ARGUMENT_OPTIONAL = 2
 } takes_argument_t;