diff options
Diffstat (limited to 'doc/html/boost/program_options/basic_parsed_options.html')
| -rw-r--r-- | doc/html/boost/program_options/basic_parsed_options.html | 49 |
1 files changed, 10 insertions, 39 deletions
diff --git a/doc/html/boost/program_options/basic_parsed_options.html b/doc/html/boost/program_options/basic_parsed_options.html index 1004910cc1..8f67db98d4 100644 --- a/doc/html/boost/program_options/basic_parsed_options.html +++ b/doc/html/boost/program_options/basic_parsed_options.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="duplicate_option_error.html" title="Class duplicate_option_error"> -<link rel="next" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>"> +<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> +<link rel="prev" href="bool_switch.html" title="Function bool_switch"> +<link rel="next" href="variable_value.html" title="Class variable_value"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.basic_parsed_options"></a><div class="titlepage"></div> @@ -30,54 +30,25 @@ <p>boost::program_options::basic_parsed_options</p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="keyword">class</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionsconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp682317840-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionspublic-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.options"><span class="identifier">options</span></a><span class="special">;</span> - <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.description"><span class="identifier">description</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp709259008-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438473552"></a><h2>Description</h2> +<a name="idp423902592"></a><h2>Description</h2> <p>Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself. </p> <div class="refsect2"> -<a name="idp438474432"></a><h3> +<a name="idp423903472"></a><h3> <a name="boost.program_options.basic_parsed_optionsconstruct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp682317840-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> xdescription<span class="special">,</span> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp709259008-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> xdescription<span class="special">,</span> <span class="keyword">int</span> options_prefix <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> -<div class="refsect2"> -<a name="idp438485920"></a><h3> -<a name="boost.program_options.basic_parsed_optionspublic-data-members"></a><code class="computeroutput">basic_parsed_options</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <a name="boost.program_options.basic_parsed_options.options"></a><span class="identifier">options</span><span class="special">;</span></pre> -<p>Options found in the source. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a name="boost.program_options.basic_parsed_options.description"></a><span class="identifier">description</span><span class="special">;</span></pre> -<p>Options description that was used for parsing. Parsers should return pointer to the instance of <a class="link" href="option_description.html" title="Class option_description">option_description</a> passed to them, and issues of lifetime are up to the caller. Can be NULL. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed_options.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> -<p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp438506880"></a><h3>Specializations</h3> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>">Class basic_parsed_options<wchar_t></a></p></li></ul></div> -</div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -90,7 +61,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |