diff options
Diffstat (limited to 'doc/html/boost/program_options/invalid_syntax.html')
-rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/invalid_syntax.html | 52 |
1 files changed, 29 insertions, 23 deletions
diff --git a/doc/html/boost/program_options/invalid_syntax.html b/doc/html/boost/program_options/invalid_syntax.html index 6b133081de..64f1393aba 100755..100644 --- a/doc/html/boost/program_options/invalid_syntax.html +++ b/doc/html/boost/program_options/invalid_syntax.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="error.html" title="Class error"> -<link rel="next" href="unknown_option.html" title="Class unknown_option"> +<link rel="prev" href="ambiguous_option.html" title="Class ambiguous_option"> +<link rel="next" href="invalid_config_file_syntax.html" title="Class invalid_config_file_syntax"> </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="error.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="unknown_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="ambiguous_option.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="invalid_config_file_syntax.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.invalid_syntax"></a><div class="titlepage"></div> @@ -32,48 +32,54 @@ <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="invalid_syntax.html" title="Class invalid_syntax">invalid_syntax</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="invalid_syntax.html" title="Class invalid_syntax">invalid_syntax</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="keyword">enum</span> <a name="boost.program_options.invalid_syntax.kind_t"></a>kind_t <span class="special">{</span> long_not_allowed = 30, long_adjacent_not_allowed, short_adjacent_not_allowed, empty_adjacent_parameter, missing_parameter, extra_parameter, unrecognized_line <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="invalid_syntax.html#boost.program_options.invalid_syntaxconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_syntax.html#id1143653-bb"><span class="identifier">invalid_syntax</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="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_syntax.html#id1143664-bb"><span class="special">~</span><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_syntax.html#id792374-bb"><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="identifier">kind_t</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="string">""</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="string">""</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> + <a class="link" href="invalid_syntax.html#id792402-bb"><span class="special">~</span><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="invalid_syntax.html#id1143636-bb">public member functions</a></span> - <span class="identifier">kind_t</span> <a class="link" href="invalid_syntax.html#id1143639-bb"><span class="identifier">kind</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="invalid_syntax.html#id1143646-bb"><span class="identifier">tokens</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="invalid_syntax.html#id792353-bb">public member functions</a></span> + <span class="identifier">kind_t</span> <a class="link" href="invalid_syntax.html#id792356-bb"><span class="identifier">kind</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="invalid_syntax.html#id792363-bb"><span class="identifier">tokens</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="invalid_syntax.html#id1143665-bb">protected static functions</a></span> - <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#id1143668-bb"><span class="identifier">error_message</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="invalid_syntax.html#id792403-bb">protected member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#id792406-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2506096"></a><h2>Description</h2> +<a name="id2559912"></a><h2>Description</h2> +<p>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </p> <div class="refsect2"> -<a name="id2506099"></a><h3> +<a name="id2559920"></a><h3> <a name="boost.program_options.invalid_syntaxconstruct-copy-destruct"></a><code class="computeroutput">invalid_syntax</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="id1143653-bb"></a><span class="identifier">invalid_syntax</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> tokens<span class="special">,</span> <span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="id1143664-bb"></a><span class="special">~</span><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id792374-bb"></a><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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="string">""</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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id792402-bb"></a><span class="special">~</span><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="id2506218"></a><h3> -<a name="id1143636-bb"></a><code class="computeroutput">invalid_syntax</code> public member functions</h3> +<a name="id2560109"></a><h3> +<a name="id792353-bb"></a><code class="computeroutput">invalid_syntax</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="identifier">kind_t</span> <a name="id1143639-bb"></a><span class="identifier">kind</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="id1143646-bb"></a><span class="identifier">tokens</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="identifier">kind_t</span> <a name="id792356-bb"></a><span class="identifier">kind</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="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id792363-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Convenience functions for backwards compatibility </p> +</li> </ol></div> </div> <div class="refsect2"> -<a name="id2506336"></a><h3> -<a name="id1143665-bb"></a><code class="computeroutput">invalid_syntax</code> protected static functions</h3> +<a name="id2560220"></a><h3> +<a name="id792403-bb"></a><code class="computeroutput">invalid_syntax</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id1143668-bb"></a><span class="identifier">error_message</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</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="id792406-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> <p>Used to convert kind_t to a related error text </p> </li></ol></div> </div> @@ -89,7 +95,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="error.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="unknown_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="ambiguous_option.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="invalid_config_file_syntax.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |