Lines Matching full:option
46 /// Constructs a generic option with both a short and a long name.
48 /// \param short_name_ The short name for the option.
49 /// \param long_name_ The long name for the option.
50 /// \param description_ A user-friendly description for the option.
51 /// \param arg_name_ If not NULL, specifies that the option must receive an
54 /// \param default_value_ If not NULL, specifies that the option has a default
72 /// Constructs a generic option with a long name only.
74 /// \param long_name_ The long name for the option.
75 /// \param description_ A user-friendly description for the option.
76 /// \param arg_name_ If not NULL, specifies that the option must receive an
79 /// \param default_value_ If not NULL, specifies that the option has a default
95 /// Destructor for the option.
101 /// Checks whether the option has a short name or not.
103 /// \return True if the option has a short name, false otherwise.
111 /// Returns the short name of the option.
124 /// Returns the long name of the option.
134 /// Returns the description of the option.
144 /// Checks whether the option needs an argument or not.
146 /// \return True if the option needs an argument, false otherwise.
154 /// Returns the argument name of the option for documentation purposes.
167 /// Checks whether the option has a default value for its argument.
171 /// \return True if the option has a default value, false otherwise.
180 /// Returns the default value for the argument to the option.
193 /// Formats the short name of the option for documentation purposes.
195 /// \return A string describing the option's short name.
209 /// Formats the long name of the option for documentation purposes.
211 /// \return A string describing the option's long name.
224 /// Ensures that an argument passed to the option is valid.
234 UNREACHABLE_MSG("Option does not support an argument"); in validate()
238 /// Constructs a boolean option with both a short and a long name.
240 /// \param short_name_ The short name for the option.
241 /// \param long_name_ The long name for the option.
242 /// \param description_ A user-friendly description for the option.
251 /// Constructs a boolean option with a long name only.
253 /// \param long_name_ The long name for the option.
254 /// \param description_ A user-friendly description for the option.
262 /// Constructs an integer option with both a short and a long name.
264 /// \param short_name_ The short name for the option.
265 /// \param long_name_ The long name for the option.
266 /// \param description_ A user-friendly description for the option.
282 /// Constructs an integer option with a long name only.
284 /// \param long_name_ The long name for the option.
285 /// \param description_ A user-friendly description for the option.
332 PRE_MSG(false, F("Raw value '%s' for int option not properly " in convert()
338 /// Constructs a list option with both a short and a long name.
340 /// \param short_name_ The short name for the option.
341 /// \param long_name_ The long name for the option.
342 /// \param description_ A user-friendly description for the option.
358 /// Constructs a list option with a long name only.
360 /// \param long_name_ The long name for the option.
361 /// \param description_ A user-friendly description for the option.
397 PRE_MSG(false, F("Raw value '%s' for list option not properly " in convert()
403 /// Constructs a path option with both a short and a long name.
405 /// \param short_name_ The short name for the option.
406 /// \param long_name_ The long name for the option.
407 /// \param description_ A user-friendly description for the option.
423 /// Constructs a path option with a long name only.
425 /// \param long_name_ The long name for the option.
426 /// \param description_ A user-friendly description for the option.
471 PRE_MSG(false, F("Raw value '%s' for path option not properly " in convert()
477 /// Constructs a property option with both a short and a long name.
479 /// \param short_name_ The short name for the option.
480 /// \param long_name_ The long name for the option.
481 /// \param description_ A user-friendly description for the option.
494 /// Constructs a property option with a long name only.
496 /// \param long_name_ The long name for the option.
497 /// \param description_ A user-friendly description for the option.
509 /// Validates the argument to a property option.
533 /// Returns the property option in a key/value pair form.
548 /// Constructs a string option with both a short and a long name.
550 /// \param short_name_ The short name for the option.
551 /// \param long_name_ The long name for the option.
552 /// \param description_ A user-friendly description for the option.
568 /// Constructs a string option with a long name only.
570 /// \param long_name_ The long name for the option.
571 /// \param description_ A user-friendly description for the option.