Document takes_argument_t and its members.

This commit is contained in:
Nick Mathewson 2019-10-08 10:50:53 -04:00
parent 4c25ea6703
commit 6cea2bd498

View File

@ -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;