From: Nick Mathewson <nickm@torproject.org>
Date: Tue, 8 Oct 2019 14:50:53 +0000 (-0400)
Subject: Document takes_argument_t and its members.
X-Git-Tag: tor-0.4.3.1-alpha~301^2~10
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6cea2bd498b15aac14b884916b7dffa76f0547b7;p=thirdparty%2Ftor.git

Document takes_argument_t and its members.
---

diff --git a/src/app/config/config.c b/src/app/config/config.c
index 561fc65456..44d6a82e56 100644
--- 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;