diff options
Diffstat (limited to 'doc/html/boost/program_options/option_description.html')
| -rw-r--r-- | doc/html/boost/program_options/option_description.html | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/doc/html/boost/program_options/option_description.html b/doc/html/boost/program_options/option_description.html index a94d000c1d..9cd07cc838 100644 --- a/doc/html/boost/program_options/option_description.html +++ b/doc/html/boost/program_options/option_description.html @@ -48,13 +48,14 @@ <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_2-bb"><span class="identifier">key</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">const</span><span class="special">;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_3-bb"><span class="identifier">canonical_display_name</span></a><span class="special">(</span><span class="keyword">int</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="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_4-bb"><span class="identifier">long_name</span></a><span class="special">(</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">string</span> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_5-bb"><span class="identifier">description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_6-bb"><span class="identifier">semantic</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_7-bb"><span class="identifier">format_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_8-bb"><span class="identifier">format_parameter</span></a><span class="special">(</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">pair</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><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_5-bb"><span class="identifier">long_names</span></a><span class="special">(</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">string</span> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_6-bb"><span class="identifier">description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_7-bb"><span class="identifier">semantic</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_8-bb"><span class="identifier">format_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_3_9-bb"><span class="identifier">format_parameter</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_8-bb">private member functions</a></span> - <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_8_1-bb"><span class="identifier">set_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a class="link" href="option_description.html#id-1_3_31_9_7_1_1_1_8_1-bb"><span class="identifier">set_names</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="id-1.3.31.9.8.3.4"></a><h2>Description</h2> @@ -108,17 +109,18 @@ </li> <li class="listitem"> <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_7_1_1_1_3_3-bb"></a><span class="identifier">canonical_display_name</span><span class="special">(</span><span class="keyword">int</span> canonical_option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>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. </p> +<p>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 first long name prefixed 3) All other cases, returns the first long name (if present) or the short name, unprefixed. </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_1_3_4-bb"></a><span class="identifier">long_name</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">pair</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><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="id-1_3_31_9_7_1_1_1_3_5-bb"></a><span class="identifier">long_names</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">string</span> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_1_3_5-bb"></a><span class="identifier">description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explanation of this option. </li> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_1_3_6-bb"></a><span class="identifier">description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explanation of this option. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a name="id-1_3_31_9_7_1_1_1_3_6-bb"></a><span class="identifier">semantic</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Semantic of option's value. </li> +<pre class="literallayout"><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a name="id-1_3_31_9_7_1_1_1_3_7-bb"></a><span class="identifier">semantic</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Semantic of option's value. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_7_1_1_1_3_7-bb"></a><span class="identifier">format_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the option name, formatted suitably for usage message. </li> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_7_1_1_1_3_8-bb"></a><span class="identifier">format_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the option name, formatted suitably for usage message. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_7_1_1_1_3_8-bb"></a><span class="identifier">format_parameter</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_7_1_1_1_3_9-bb"></a><span class="identifier">format_parameter</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the parameter name and properties, formatted suitably for usage message. </p> </li> </ol></div> @@ -126,7 +128,7 @@ <div class="refsect2"> <a name="id-1.3.31.9.8.3.4.5"></a><h3> <a name="id-1_3_31_9_7_1_1_1_8-bb"></a><code class="computeroutput">option_description</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_1_8_1-bb"></a><span class="identifier">set_name</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a name="id-1_3_31_9_7_1_1_1_8_1-bb"></a><span class="identifier">set_names</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> |