diff options
Diffstat (limited to 'libs/program_options/doc/autodoc.xml')
| -rw-r--r-- | libs/program_options/doc/autodoc.xml | 60 |
1 files changed, 23 insertions, 37 deletions
diff --git a/libs/program_options/doc/autodoc.xml b/libs/program_options/doc/autodoc.xml index 729e4d1a0b..d7fc6a3a0b 100644 --- a/libs/program_options/doc/autodoc.xml +++ b/libs/program_options/doc/autodoc.xml @@ -3,12 +3,10 @@ <namespace name="boost"> <namespace name="program_options"> <namespace name="command_line_style"> -<enum name="style_t"><enumvalue name="allow_long"><default> 1</default><purpose>Allow "--long_name" style. </purpose></enumvalue><enumvalue name="allow_short"><default> allow_long << 1</default><purpose>Allow "-<single character" style. </purpose></enumvalue><enumvalue name="allow_dash_for_short"><default> allow_short << 1</default><purpose>Allow "-" in short options. </purpose></enumvalue><enumvalue name="allow_slash_for_short"><default> allow_dash_for_short << 1</default><purpose>Allow "/" in short options. </purpose></enumvalue><enumvalue name="long_allow_adjacent"><default> allow_slash_for_short << 1</default><description><para>Allow option parameter in the same token for long option, like in - --foo=10 - </para></description></enumvalue><enumvalue name="long_allow_next"><default> long_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for long options. </para></description></enumvalue><enumvalue name="short_allow_adjacent"><default> long_allow_next << 1</default><description><para>Allow option parameter in the same token for short options. </para></description></enumvalue><enumvalue name="short_allow_next"><default> short_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for short options. </para></description></enumvalue><enumvalue name="allow_sticky"><default> short_allow_next << 1</default><description><para>Allow to merge several short options together, so that "-s -k" become "-sk". All of the options but last should accept no parameter. For example, if "-s" accept a parameter, then "k" will be taken as parameter, not another short option. Dos-style short options cannot be sticky. </para></description></enumvalue><enumvalue name="allow_guessing"><default> allow_sticky << 1</default><description><para>Allow abbreviated spellings for long options, if they unambiguously identify long option. No long option name should be prefix of other long option name if guessing is in effect. </para></description></enumvalue><enumvalue name="long_case_insensitive"><default> allow_guessing << 1</default><description><para>Ignore the difference in case for long options. </para></description></enumvalue><enumvalue name="short_case_insensitive"><default> long_case_insensitive << 1</default><description><para>Ignore the difference in case for short options. </para></description></enumvalue><enumvalue name="case_insensitive"><default> (long_case_insensitive | short_case_insensitive)</default><description><para>Ignore the difference in case for all options. </para></description></enumvalue><enumvalue name="allow_long_disguise"><default> short_case_insensitive << 1</default><description><para>Allow long options with single option starting character, e.g <computeroutput>-foo=10</computeroutput> </para></description></enumvalue><enumvalue name="unix_style"><default> (allow_short | short_allow_adjacent | short_allow_next +<enum name="style_t"><enumvalue name="allow_long"><default>= 1</default><purpose>Allow "--long_name" style. </purpose></enumvalue><enumvalue name="allow_short"><default>= allow_long << 1</default><purpose>Allow "-<single character" style. </purpose></enumvalue><enumvalue name="allow_dash_for_short"><default>= allow_short << 1</default><purpose>Allow "-" in short options. </purpose></enumvalue><enumvalue name="allow_slash_for_short"><default>= allow_dash_for_short << 1</default><purpose>Allow "/" in short options. </purpose></enumvalue><enumvalue name="long_allow_adjacent"><default>= allow_slash_for_short << 1</default><description><para>Allow option parameter in the same token for long option, like in --foo=10 </para></description></enumvalue><enumvalue name="long_allow_next"><default>= long_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for long options. </para></description></enumvalue><enumvalue name="short_allow_adjacent"><default>= long_allow_next << 1</default><description><para>Allow option parameter in the same token for short options. </para></description></enumvalue><enumvalue name="short_allow_next"><default>= short_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for short options. </para></description></enumvalue><enumvalue name="allow_sticky"><default>= short_allow_next << 1</default><description><para>Allow to merge several short options together, so that "-s -k" become "-sk". All of the options but last should accept no parameter. For example, if "-s" accept a parameter, then "k" will be taken as parameter, not another short option. Dos-style short options cannot be sticky. </para></description></enumvalue><enumvalue name="allow_guessing"><default>= allow_sticky << 1</default><description><para>Allow abbreviated spellings for long options, if they unambiguously identify long option. No long option name should be prefix of other long option name if guessing is in effect. </para></description></enumvalue><enumvalue name="long_case_insensitive"><default>= allow_guessing << 1</default><description><para>Ignore the difference in case for long options. </para></description></enumvalue><enumvalue name="short_case_insensitive"><default>= long_case_insensitive << 1</default><description><para>Ignore the difference in case for short options. </para></description></enumvalue><enumvalue name="case_insensitive"><default>= (long_case_insensitive | short_case_insensitive)</default><description><para>Ignore the difference in case for all options. </para></description></enumvalue><enumvalue name="allow_long_disguise"><default>= short_case_insensitive << 1</default><description><para>Allow long options with single option starting character, e.g <computeroutput>-foo=10</computeroutput> </para></description></enumvalue><enumvalue name="unix_style"><default>= (allow_short | short_allow_adjacent | short_allow_next | allow_long | long_allow_adjacent | long_allow_next | allow_sticky | allow_guessing - | allow_dash_for_short)</default><description><para>The more-or-less traditional unix style. </para></description></enumvalue><enumvalue name="default_style"><default> unix_style</default><description><para>The default style. </para></description></enumvalue><description><para>Various possible styles of options.</para><para>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</para><para>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</para><para>It's possible to introduce long options by the same character as short options, see allow_long_disguise.</para><para>Finally, guessing (specifying only prefix of option) and case insensitive processing are supported. </para></description></enum> + | allow_dash_for_short)</default><description><para>The more-or-less traditional unix style. </para></description></enumvalue><enumvalue name="default_style"><default>= unix_style</default><description><para>The default style. </para></description></enumvalue><description><para>Various possible styles of options.</para><para>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</para><para>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</para><para>It's possible to introduce long options by the same character as short options, see allow_long_disguise.</para><para>Finally, guessing (specifying only prefix of option) and case insensitive processing are supported. </para></description></enum> </namespace> @@ -49,8 +47,10 @@ <class name="eof_iterator"><template> <template-type-parameter name="Derived"/> <template-type-parameter name="ValueType"/> - </template><inherit access="public">iterator_facade< Derived, const ValueType, forward_traversal_tag ></inherit><description><para>The '<classname alt="boost::eof_iterator">eof_iterator</classname>' class is useful for constructing forward iterators in cases where iterator extract data from some source and it's easy to detect 'eof' \-- i.e. the situation where there's no data. One apparent example is reading lines from a file.</para><para>Implementing such iterators using '<classname alt="iterator_facade">iterator_facade</classname>' directly would require to create class with three core operation, a couple of constructors. When using '<classname alt="boost::eof_iterator">eof_iterator</classname>', the derived class should define only one method to get new value, plus a couple of constructors.</para><para>The basic idea is that iterator has 'eof' bit. Two iterators are equal only if both have their 'eof' bits set. The 'get' method either obtains the new value or sets the 'eof' bit.</para><para>Specifically, derived class should define:</para><para>1. A default constructor, which creates iterator with 'eof' bit set. The constructor body should call 'found_eof' method defined here. 2. Some other constructor. It should initialize some 'data pointer' used in iterator operation and then call 'get'. 3. The 'get' method. It should operate this way:<itemizedlist> + </template><inherit access="public">iterator_facade< Derived, const ValueType, forward_traversal_tag ></inherit><description><para>The '<classname alt="boost::eof_iterator">eof_iterator</classname>' class is useful for constructing forward iterators in cases where iterator extract data from some source and it's easy to detect 'eof' -- i.e. the situation where there's no data. One apparent example is reading lines from a file.</para><para>Implementing such iterators using 'iterator_facade' directly would require to create class with three core operation, a couple of constructors. When using '<classname alt="boost::eof_iterator">eof_iterator</classname>', the derived class should define only one method to get new value, plus a couple of constructors.</para><para>The basic idea is that iterator has 'eof' bit. Two iterators are equal only if both have their 'eof' bits set. The 'get' method either obtains the new value or sets the 'eof' bit.</para><para>Specifically, derived class should define:</para><para><orderedlist> +<listitem><para>A default constructor, which creates iterator with 'eof' bit set. The constructor body should call 'found_eof' method defined here.</para></listitem><listitem><para>Some other constructor. It should initialize some 'data pointer' used in iterator operation and then call 'get'.</para></listitem><listitem><para>The 'get' method. It should operate this way:<itemizedlist> <listitem><para>look at some 'data pointer' to see if new element is available; if not, it should call 'found_eof'.</para></listitem><listitem><para>extract new element and store it at location returned by the 'value' method.</para></listitem><listitem><para>advance the data pointer.</para></listitem></itemizedlist> +</para></listitem></orderedlist> </para><para>Essentially, the 'get' method has the functionality of both 'increment' and 'dereference'. It's very good for the cases where data extraction implicitly moves data pointer, like for stream operation. </para></description><method-group name="public member functions"> </method-group> <constructor/> @@ -68,7 +68,7 @@ <header name="boost/program_options/errors.hpp"> <namespace name="boost"> <namespace name="program_options"> -<class name="error"><description><para>Base class for all errors in the library. </para></description><method-group name="public member functions"> +<class name="error"><inherit access="public">logic_error</inherit><description><para>Base class for all errors in the library. </para></description><method-group name="public member functions"> </method-group> <constructor><parameter name="xwhat"><paramtype>const std::string &</paramtype></parameter></constructor> </class><class name="too_many_positional_options_error"><inherit access="public">boost::program_options::error</inherit><description><para>Class thrown when there are too many positional options. This is a programming error. </para></description><method-group name="public member functions"> @@ -80,7 +80,7 @@ </class><class name="reading_file"><inherit access="public">boost::program_options::error</inherit><description><para>Class thrown if config file can not be read </para></description><method-group name="public member functions"> </method-group> <constructor><parameter name="filename"><paramtype>const char *</paramtype></parameter></constructor> -</class><class name="error_with_option_name"><inherit access="public">boost::program_options::error</inherit><description><para>Base class for most exceptions in the library.</para><para>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</para><para>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</para><para>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</para><para>Options are displayed in "canonical" form This is the most unambiguous form of the *parsed* option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</para><para>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </para></description><data-member name="m_error_template"><type>std::string</type><description><para>template with placeholders </para></description></data-member> +</class><class name="error_with_option_name"><inherit access="public">boost::program_options::error</inherit><description><para>Base class for most exceptions in the library.</para><para>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</para><para>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</para><para>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</para><para>Options are displayed in "canonical" form This is the most unambiguous form of the <emphasis>parsed</emphasis> option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</para><para>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </para></description><data-member name="m_error_template"><type>std::string</type><description><para>template with placeholders </para></description></data-member> <method-group name="public member functions"> <method name="set_substitute"><type>void</type><parameter name="parameter_name"><paramtype>const std::string &</paramtype></parameter><parameter name="value"><paramtype>const std::string &</paramtype></parameter><description><para>Substitute parameter_name->value to create the error message from the error template </para></description></method> <method name="set_substitute_default"><type>void</type><parameter name="parameter_name"><paramtype>const std::string &</paramtype></parameter><parameter name="from"><paramtype>const std::string &</paramtype></parameter><parameter name="to"><paramtype>const std::string &</paramtype></parameter><description><para>If the parameter is missing, then make the from->to substitution instead </para></description></method> @@ -128,7 +128,7 @@ <method-group name="protected member functions"> <method name="substitute_placeholders" cv="const" specifiers="virtual"><type>void</type><parameter name="error_template"><paramtype>const std::string &</paramtype></parameter><description><para>Makes all substitutions using the template </para></description></method> </method-group> -</class><class name="invalid_syntax"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </para></description><enum name="kind_t"><enumvalue name="long_not_allowed"><default> 30</default></enumvalue><enumvalue name="long_adjacent_not_allowed"/><enumvalue name="short_adjacent_not_allowed"/><enumvalue name="empty_adjacent_parameter"/><enumvalue name="missing_parameter"/><enumvalue name="extra_parameter"/><enumvalue name="unrecognized_line"/></enum> +</class><class name="invalid_syntax"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </para></description><enum name="kind_t"><enumvalue name="long_not_allowed"><default>= 30</default></enumvalue><enumvalue name="long_adjacent_not_allowed"/><enumvalue name="short_adjacent_not_allowed"/><enumvalue name="empty_adjacent_parameter"/><enumvalue name="missing_parameter"/><enumvalue name="extra_parameter"/><enumvalue name="unrecognized_line"/></enum> <method-group name="public member functions"> <method name="kind" cv="const"><type>kind_t</type></method> <method name="tokens" cv="const" specifiers="virtual"><type>std::string</type><description><para>Convenience functions for backwards compatibility </para></description></method> @@ -147,7 +147,7 @@ </method-group> <constructor><parameter name="kind"><paramtype>kind_t</paramtype></parameter><parameter name="option_name"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="original_token"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="option_style"><paramtype>int</paramtype><default>0</default></parameter></constructor> <destructor/> -</class><class name="validation_error"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when value of option is incorrect. </para></description><enum name="kind_t"><enumvalue name="multiple_values_not_allowed"><default> 30</default></enumvalue><enumvalue name="at_least_one_value_required"/><enumvalue name="invalid_bool_value"/><enumvalue name="invalid_option_value"/><enumvalue name="invalid_option"/></enum> +</class><class name="validation_error"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when value of option is incorrect. </para></description><enum name="kind_t"><enumvalue name="multiple_values_not_allowed"><default>= 30</default></enumvalue><enumvalue name="at_least_one_value_required"/><enumvalue name="invalid_bool_value"/><enumvalue name="invalid_option_value"/><enumvalue name="invalid_option"/></enum> <method-group name="public member functions"> </method-group> <constructor><parameter name="kind"><paramtype>kind_t</paramtype></parameter><parameter name="option_name"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="original_token"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="option_style"><paramtype>int</paramtype><default>0</default></parameter></constructor> @@ -168,7 +168,6 @@ -<function name="strip_prefixes"><type>std::string</type><parameter name="text"><paramtype>const std::string &</paramtype></parameter></function> @@ -178,6 +177,7 @@ +<function name="strip_prefixes"><type>std::string</type><parameter name="text"><paramtype>const std::string &</paramtype></parameter></function> @@ -189,7 +189,7 @@ <namespace name="program_options"> <class name="basic_option"><template> <template-type-parameter name="charT"/> - </template><description><para>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) \-- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </para></description><data-member name="string_key"><type>std::string</type><description><para>String key of this option. Intentionally independent of the template parameter. </para></description></data-member> + </template><description><para>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) -- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </para></description><data-member name="string_key"><type>std::string</type><description><para>String key of this option. Intentionally independent of the template parameter. </para></description></data-member> <data-member name="position_key"><type>int</type><description><para>Position key of this option. All options without an explicit name are sequentially numbered starting from 0. If an option has explicit name, 'position_key' is equal to -1. It is possible that both position_key and string_key is specified, in case name is implicitly added. </para></description></data-member> <data-member name="value"><type>std::vector< std::basic_string< charT > ></type><description><para>Option's value </para></description></data-member> <data-member name="original_tokens"><type>std::vector< std::basic_string< charT > ></type><description><para>The original unchanged tokens this option was created from. </para></description></data-member> @@ -226,12 +226,12 @@ <header name="boost/program_options/options_description.hpp"> <namespace name="boost"> <namespace name="program_options"> -<class name="option_description"><description><para>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties \-- they are side effect free. <para><emphasis role="bold">See Also:</emphasis><para><classname alt="boost::program_options::options_description">options_description</classname> </para></para> +<class name="option_description"><description><para>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties -- they are side effect free. <para><emphasis role="bold">See Also:</emphasis><para><classname alt="boost::program_options::options_description">options_description</classname> </para></para> </para></description><enum name="match_result"><enumvalue name="no_match"/><enumvalue name="full_match"/><enumvalue name="approximate_match"/></enum> <method-group name="public member functions"> <method name="match" cv="const"><type>match_result</type><parameter name="option"><paramtype>const std::string &</paramtype></parameter><parameter name="approx"><paramtype>bool</paramtype></parameter><parameter name="long_ignore_case"><paramtype>bool</paramtype></parameter><parameter name="short_ignore_case"><paramtype>bool</paramtype></parameter><description><para>Given 'option', specified in the input source, returns 'true' if 'option' specifies *this. </para></description></method> <method name="key" cv="const"><type>const std::string &</type><parameter name="option"><paramtype>const std::string &</paramtype></parameter><description><para>Returns the key that should identify the option, in particular in the <classname alt="boost::program_options::variables_map">variables_map</classname> class. The 'option' parameter is the option spelling from the input source. If option name contains '*', returns 'option'. If long name was specified, it's the long name, otherwise it's a short name with prepended '-'. </para></description></method> -<method name="canonical_display_name" cv="const"><type>std::string</type><parameter name="canonical_option_style"><paramtype>int</paramtype><default>0</default></parameter><description><para>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('--' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </para></description></method> +<method name="canonical_display_name" cv="const"><type>std::string</type><parameter name="canonical_option_style"><paramtype>int</paramtype><default>0</default></parameter><description><para>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('–' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </para></description></method> <method name="long_name" cv="const"><type>const std::string &</type></method> <method name="description" cv="const"><type>const std::string &</type><purpose>Explanation of this option. </purpose></method> <method name="semantic" cv="const"><type>shared_ptr< const <classname>value_semantic</classname> ></type><purpose>Semantic of option's value. </purpose></method> @@ -240,7 +240,7 @@ </method-group> <constructor/> <constructor><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="s"><paramtype>const <classname>value_semantic</classname> *</paramtype></parameter><description><para>Initializes the object with the passed data.</para><para>Note: it would be nice to make the second parameter auto_ptr, to explicitly pass ownership. Unfortunately, it's often needed to create objects of types derived from '<classname alt="boost::program_options::value_semantic">value_semantic</classname>': <classname alt="boost::program_options::options_description">options_description</classname> d; d.add_options()("a", parameter<int>("n")->default_value(1)); Here, the static type returned by 'parameter' should be derived from <classname alt="boost::program_options::value_semantic">value_semantic</classname>.</para><para>Alas, derived->base conversion for auto_ptr does not really work, see <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf">http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf</ulink> <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84">http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84</ulink></para><para>So, we have to use plain old pointers. Besides, users are not expected to use the constructor directly.</para><para>The 'name' parameter is interpreted by the following rules:<itemizedlist> -<listitem><para>if there's no "," character in 'name', it specifies long name</para></listitem><listitem><para>otherwise, the part before "," specifies long name and the part after \-- short name. </para></listitem></itemizedlist> +<listitem><para>if there's no "," character in 'name', it specifies long name</para></listitem><listitem><para>otherwise, the part before "," specifies long name and the part after -- short name. </para></listitem></itemizedlist> </para></description></constructor> <constructor><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="s"><paramtype>const <classname>value_semantic</classname> *</paramtype></parameter><parameter name="description"><paramtype>const char *</paramtype></parameter><description><para>Initializes the class with the passed data. </para></description></constructor> <destructor/> @@ -318,7 +318,7 @@ <constructor specifiers="explicit"><parameter name="po"><paramtype>const <classname>basic_parsed_options</classname>< char > &</paramtype></parameter><description><para>Constructs wrapped options from options in UTF8 encoding. </para></description></constructor> </class-specialization><class name="basic_command_line_parser"><template> <template-type-parameter name="charT"/> - </template><description><para>Command line parser.</para><para>The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters \-- a regular function with 5 parameters will be hard to use and creating overloads with a smaller number of parameters will be confusing.</para><para>For the most common case, the function parse_command_line is a better alternative.</para><para>There are two typedefs \-- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </para></description><method-group name="public member functions"> + </template><inherit access="private">cmdline</inherit><description><para>Command line parser.</para><para>The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller number of parameters will be confusing.</para><para>For the most common case, the function parse_command_line is a better alternative.</para><para>There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </para></description><method-group name="public member functions"> <method name="options"><type><classname>basic_command_line_parser</classname> &</type><parameter name="desc"><paramtype>const <classname>options_description</classname> &</paramtype></parameter><description><para>Sets options descriptions to use. </para></description></method> <method name="positional"><type><classname>basic_command_line_parser</classname> &</type><parameter name="desc"><paramtype>const <classname>positional_options_description</classname> &</paramtype></parameter><description><para>Sets positional options description to use. </para></description></method> <method name="style"><type><classname>basic_command_line_parser</classname> &</type><parameter name=""><paramtype>int</paramtype></parameter><description><para>Sets the command line style. </para></description></method> @@ -341,7 +341,6 @@ - <function name="parse_command_line"><type><classname>basic_parsed_options</classname>< charT ></type><template> <template-type-parameter name="charT"/> </template><parameter name="argc"><paramtype>int</paramtype></parameter><parameter name="argv"><paramtype>const charT *const</paramtype></parameter><parameter name=""><paramtype>const <classname>options_description</classname> &</paramtype></parameter><parameter name="style"><paramtype>int</paramtype><default>0</default></parameter><parameter name="ext"><paramtype>function1< std::pair< std::string, std::string >, const std::string & ></paramtype><default>ext_parser()</default></parameter><description><para>Creates instance of 'command_line_parser', passes parameters to it, and returns the result of calling the 'run' method. </para></description></function> @@ -362,6 +361,7 @@ + </namespace> </namespace> </header> @@ -449,9 +449,9 @@ </template><inherit access="public">boost::program_options::value_semantic_codecvt_helper< charT ></inherit><inherit access="public">boost::program_options::typed_value_base</inherit><description><para>Class which handles value of a specific type. </para></description><method-group name="public member functions"> <method name="default_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies default value, which will be used if none is explicitly specified. The type 'T' should provide operator<< for ostream. </para></description></method> <method name="default_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies default value, which will be used if none is explicitly specified. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> -<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. </para></description></method> +<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. </para></description></method> <method name="value_name"><type><classname>typed_value</classname> *</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies the name used to to the value in help message. </para></description></method> -<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> +<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> <method name="notifier"><type><classname>typed_value</classname> *</type><parameter name="f"><paramtype>function1< void, const T & ></paramtype></parameter><description><para>Specifies a function to be called when the final value is determined. </para></description></method> <method name="composing"><type><classname>typed_value</classname> *</type><description><para>Specifies that the value is composing. See the 'is_composing' method for explanation. </para></description></method> <method name="multitoken"><type><classname>typed_value</classname> *</type><description><para>Specifies that the value can span multiple tokens. </para></description></method> @@ -523,13 +523,9 @@ <method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</para><para><itemizedlist> <listitem><para>if there's no value in *this.<itemizedlist> <listitem><para>if there's next variable map, returns value from it</para></listitem><listitem><para>otherwise, returns empty value</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's defaulted value<itemizedlist> +</para></listitem><listitem><para>if there's defaulted value<itemizedlist> <listitem><para>if there's next variable map, which has a non-defaulted value, return that</para></listitem><listitem><para>otherwise, return value from *this</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> +</para></listitem><listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> </para></description></method> <method name="next"><type>void</type><parameter name="next"><paramtype><classname>abstract_variables_map</classname> *</paramtype></parameter><description><para>Sets next variable map, which will be used to find variables not found in *this. </para></description></method> </method-group> @@ -539,18 +535,8 @@ <method-group name="private member functions"> <method name="get" cv="const = 0" specifiers="virtual"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Returns value of variable 'name' stored in *this, or empty value otherwise. </para></description></method> </method-group> -</class><class name="variables_map"><inherit access="public">boost::program_options::abstract_variables_map</inherit><description><para>Concrete variables map which store variables in real map.</para><para>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </para></description><method-group name="public member functions"> -<method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</para><para><itemizedlist> -<listitem><para>if there's no value in *this.<itemizedlist> -<listitem><para>if there's next variable map, returns value from it</para></listitem><listitem><para>otherwise, returns empty value</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's defaulted value<itemizedlist> -<listitem><para>if there's next variable map, which has a non-defaulted value, return that</para></listitem><listitem><para>otherwise, return value from *this</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> -</para></description></method> +</class><class name="variables_map"><inherit access="public">boost::program_options::abstract_variables_map</inherit><inherit access="public">std::map< std::string, variable_value ></inherit><description><para>Concrete variables map which store variables in real map.</para><para>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </para></description><method-group name="public member functions"> +<method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter></method> <method name="clear"><type>void</type></method> <method name="notify"><type>void</type></method> </method-group> @@ -587,4 +573,4 @@ <header name="boost/program_options/version.hpp"> <macro name="BOOST_PROGRAM_OPTIONS_VERSION"><description><para>The version of the source interface. The value will be incremented whenever a change is made which might cause compilation errors for existing code. </para></description></macro> </header> -</library-reference> +</library-reference>
\ No newline at end of file |