diff options
Diffstat (limited to 'doc/html/boost/program_options/options_description.html')
| -rw-r--r-- | doc/html/boost/program_options/options_description.html | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/html/boost/program_options/options_description.html b/doc/html/boost/program_options/options_description.html index 6429e6bb37..9b08754bab 100644 --- a/doc/html/boost/program_options/options_description.html +++ b/doc/html/boost/program_options/options_description.html @@ -7,7 +7,7 @@ <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.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="options_descr_idp690702112.html" title="Class options_description_easy_init"> +<link rel="prev" href="options_d_1_3_31_9_7_1_1_2.html" title="Class options_description_easy_init"> <link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_descr_idp690702112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_d_1_3_31_9_7_1_1_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.options_description"></a><div class="titlepage"></div> @@ -36,32 +36,32 @@ <span class="keyword">class</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="options_description.html#boost.program_options.options_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="options_description.html#idp690745904-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> + <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_4-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html#idp690748560-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> + <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_5-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="options_description.html#idp690719008-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp690719568-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a class="link" href="options_description.html#idp690722080-bb"><span class="identifier">add</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="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="options_description.html#idp690724944-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="options_descr_idp690702112.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#idp690726544-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_1-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_2-bb"><span class="identifier">add</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="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_3-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_d_1_3_31_9_7_1_1_2.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_4-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> - <a class="link" href="options_description.html#idp690730368-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_5-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> - <a class="link" href="options_description.html#idp690735264-bb"><span class="identifier">find_nothrow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a class="link" href="options_description.html#idp690740160-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp690741744-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_6-bb"><span class="identifier">find_nothrow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_7-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_3_8-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="options_description.html#idp690752928-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_6-bb">friend functions</a></span> <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> - <a class="link" href="options_description.html#idp690753488-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_description.html#id-1_3_31_9_7_1_1_3_6_1-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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><span class="special">)</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="identifier">m_default_line_length</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440739968"></a><h2>Description</h2> +<a name="id-1.3.31.9.8.5.4"></a><h2>Description</h2> <p>A set of option descriptions. This provides convenient interface for adding new option (the add_options) method, and facilities to search for options by name.</p> <p>See here for option adding interface discussion. </p> <p><span class="bold"><strong>See Also:</strong></span></p> @@ -69,18 +69,18 @@ <p> </p> <div class="refsect2"> -<a name="idp440742880"></a><h3> +<a name="id-1.3.31.9.8.5.4.4"></a><h3> <a name="boost.program_options.options_descriptionconstruct-copy-destruct"></a><code class="computeroutput">options_description</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp690745904-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> +<pre class="literallayout"><a name="id-1_3_31_9_7_1_1_3_4-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates the instance. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp690748560-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> caption<span class="special">,</span> +<pre class="literallayout"><a name="id-1_3_31_9_7_1_1_3_5-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> caption<span class="special">,</span> <span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates the instance. The 'caption' parameter gives the name of this '<code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>' instance. Primarily useful for output. The 'description_length' specifies the number of columns that should be reserved for the description text; if the option text encroaches into this, then the description will start on the next line. </p> @@ -88,44 +88,44 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp440769504"></a><h3> -<a name="idp690719008-bb"></a><code class="computeroutput">options_description</code> public member functions</h3> +<a name="id-1.3.31.9.8.5.4.5"></a><h3> +<a name="id-1_3_31_9_7_1_1_3_3-bb"></a><code class="computeroutput">options_description</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp690719568-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_7_1_1_3_3_1-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a name="idp690722080-bb"></a><span class="identifier">add</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> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_3_3_2-bb"></a><span class="identifier">add</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> desc<span class="special">)</span><span class="special">;</span></pre> <p>Adds a group of option description. This has the same effect as adding all option_descriptions in 'desc' individually, except that output operator will show a separate group. Returns *this. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp690724944-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">unsigned</span> <a name="id-1_3_31_9_7_1_1_3_3_3-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Find the maximum width of the option column, including options in groups. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="options_descr_idp690702112.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="idp690726544-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="options_d_1_3_31_9_7_1_1_2.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="id-1_3_31_9_7_1_1_3_3_4-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns an object of implementation-defined type suitable for adding options to <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>. The returned object will have overloaded operator() with parameter type matching '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructors. Calling the operator will create new <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> instance and add it. </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> -<a name="idp690730368-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> +<a name="id-1_3_31_9_7_1_1_3_3_5-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> -<a name="idp690735264-bb"></a><span class="identifier">find_nothrow</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> +<a name="id-1_3_31_9_7_1_1_3_3_6-bb"></a><span class="identifier">find_nothrow</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a name="idp690740160-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_3_3_7-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp690741744-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_7_1_1_3_3_8-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Outputs 'desc' to the specified stream, calling 'f' to output each <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> element. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp440856784"></a><h3> -<a name="idp690752928-bb"></a><code class="computeroutput">options_description</code> friend functions</h3> +<a name="id-1.3.31.9.8.5.4.6"></a><h3> +<a name="id-1_3_31_9_7_1_1_3_6-bb"></a><code class="computeroutput">options_description</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> -<a name="idp690753488-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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> desc<span class="special">)</span><span class="special">;</span></pre> +<a name="id-1_3_31_9_7_1_1_3_6_1-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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> desc<span class="special">)</span><span class="special">;</span></pre> <p>Produces a human readable output of 'desc', listing options, their descriptions and allowed parameters. Other <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> instances previously passed to add will be output separately. </p> </li></ol></div> </div> @@ -141,7 +141,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_descr_idp690702112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_d_1_3_31_9_7_1_1_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |