diff options
Diffstat (limited to 'doc/html/boost/program_options/required_option.html')
-rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/required_option.html | 30 |
1 files changed, 11 insertions, 19 deletions
diff --git a/doc/html/boost/program_options/required_option.html b/doc/html/boost/program_options/required_option.html index 37f41bf5e2..8198d915bb 100755..100644 --- a/doc/html/boost/program_options/required_option.html +++ b/doc/html/boost/program_options/required_option.html @@ -6,8 +6,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.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.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="reading_file.html" title="Class reading_file"> -<link rel="next" href="basic_option.html" title="Class template basic_option"> +<link rel="prev" href="multiple_occurrences.html" title="Class multiple_occurrences"> +<link rel="next" href="error_with_no_option_name.html" title="Class error_with_no_option_name"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="reading_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_no_option_name.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.required_option"></a><div class="titlepage"></div> @@ -32,33 +32,25 @@ <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.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="required_option.html" title="Class required_option">required_option</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="required_option.html" title="Class required_option">required_option</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="required_option.html#boost.program_options.required_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="required_option.html#id1150148-bb"><span class="identifier">required_option</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="special">;</span> - <a class="link" href="required_option.html#id1150154-bb"><span class="special">~</span><span class="identifier">required_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="required_option.html#id1150138-bb">public member functions</a></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="required_option.html#id1150141-bb"><span class="identifier">get_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="required_option.html#id795856-bb"><span class="identifier">required_option</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="special">;</span> + <a class="link" href="required_option.html#id795862-bb"><span class="special">~</span><span class="identifier">required_option</span></a><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="id2511187"></a><h2>Description</h2> +<a name="id2557734"></a><h2>Description</h2> <p>Class thrown when a required/mandatory option is missing </p> <div class="refsect2"> -<a name="id2511194"></a><h3> +<a name="id2557741"></a><h3> <a name="boost.program_options.required_optionconstruct-copy-destruct"></a><code class="computeroutput">required_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="id1150148-bb"></a><span class="identifier">required_option</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="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="id1150154-bb"></a><span class="special">~</span><span class="identifier">required_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id795856-bb"></a><span class="identifier">required_option</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> option_name<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id795862-bb"></a><span class="special">~</span><span class="identifier">required_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> -<div class="refsect2"> -<a name="id2511302"></a><h3> -<a name="id1150138-bb"></a><code class="computeroutput">required_option</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><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="id1150141-bb"></a><span class="identifier">get_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> -</div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -71,7 +63,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="reading_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_no_option_name.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |