Update docs.

boostorg · Mar 15, 2024 · 48f12be · 48f12be
1 parent 656638e
commit 48f12be
Show file tree

Hide file tree

Showing 265 changed files with 7,258 additions and 3,542 deletions.
diff --git a/doc/html/BOOST_PARSER_ALGO_idm22568.html → doc/html/BOOST_PARSER_ALGO_idm29927.html b/doc/html/BOOST_PARSER_ALGO_idm22568.html → doc/html/BOOST_PARSER_ALGO_idm29927.html
@@ -15,7 +15,7 @@
 <a accesskey="p" href="BOOST_PARSER_SUBRANGE.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_USE_CONCEPTS.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
-<a name="BOOST_PARSER_ALGO_idm22568"></a><div class="titlepage"></div>
+<a name="BOOST_PARSER_ALGO_idm29927"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Macro BOOST_PARSER_ALGO_CONSTEXPR</span></h2>
 <p>BOOST_PARSER_ALGO_CONSTEXPR</p>

diff --git a/doc/html/BOOST_PARSER_ASSERT.html b/doc/html/BOOST_PARSER_ASSERT.html
@@ -6,13 +6,13 @@
 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="Chapter 1. Boost.Parser (Proposed)">
 <link rel="up" href="header/boost/parser/config_hpp.html" title="Header &lt;boost/parser/config.hpp&gt;">
-<link rel="prev" href="BOOST_PARSER_NO_R_idm22538.html" title="Macro BOOST_PARSER_NO_RUNTIME_ASSERTIONS">
-<link rel="next" href="BOOST_PARSER_DISA_idm22550.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
+<link rel="prev" href="BOOST_PARSER_NO_R_idm29897.html" title="Macro BOOST_PARSER_NO_RUNTIME_ASSERTIONS">
+<link rel="next" href="BOOST_PARSER_DISA_idm29909.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_NO_R_idm22538.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm22550.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_NO_R_idm29897.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm29909.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
 <a name="BOOST_PARSER_ASSERT"></a><div class="titlepage"></div>
@@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_ASSERT(condition)</pre></div>
 <div class="refsect1">
-<a name="idm21077"></a><h2>Description</h2>
+<a name="idm27848"></a><h2>Description</h2>
 <p>Asserts that the given condition is true. If <code class="computeroutput">BOOST_PARSER_NO_RUNTIME_ASSERTIONS</code> macro is defined by the user, <code class="computeroutput">BOOST_PARSER_ASSERT</code> expends to a compile-time <code class="computeroutput">static_assert()</code>. Otherwise, it expands to a run-time <code class="computeroutput">BOOST_ASSERT()</code>. </p>
 </div>
 </div>
@@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 </div>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_NO_R_idm22538.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm22550.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_NO_R_idm29897.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm29909.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/doc/html/BOOST_PARSER_DEFINE_RULES.html b/doc/html/BOOST_PARSER_DEFINE_RULES.html
@@ -6,13 +6,13 @@
 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="Chapter 1. Boost.Parser (Proposed)">
 <link rel="up" href="header/boost/parser/parser_hpp.html" title="Header &lt;boost/parser/parser.hpp&gt;">
-<link rel="prev" href="boost/parser/callback_parse_idm27388.html" title="Function template callback_parse">
+<link rel="prev" href="boost/parser/callback_parse_idm32854.html" title="Function template callback_parse">
 <link rel="next" href="header/boost/parser/parser_fwd_hpp.html" title="Header &lt;boost/parser/parser_fwd.hpp&gt;">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="spirit-nav">
-<a accesskey="p" href="boost/parser/callback_parse_idm27388.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/parser_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/parser/parser_fwd_hpp.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="boost/parser/callback_parse_idm32854.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/parser_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/parser/parser_fwd_hpp.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
 <a name="BOOST_PARSER_DEFINE_RULES"></a><div class="titlepage"></div>
@@ -25,8 +25,8 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_DEFINE_RULES(...)</pre></div>
 <div class="refsect1">
-<a name="idm40695"></a><h2>Description</h2>
-<p>For each given token <code class="computeroutput">t</code>, defines a pair of <code class="computeroutput">parse_rule()</code> overloads, used internally within Boost.Parser. Each such pair implements the parsing behavior rule <code class="computeroutput">t</code>, using the parser <code class="computeroutput">t_def</code>. This macro is only available when the Boost.Preprocessor headers are available. </p>
+<a name="idm39416"></a><h2>Description</h2>
+<p>For each given token <code class="computeroutput">t</code>, defines a pair of <code class="computeroutput">parse_rule()</code> overloads, used internally within Boost.Parser. Each such pair implements the parsing behavior rule <code class="computeroutput">t</code>, using the parser <code class="computeroutput">t_def</code>. This implementation is in the form of a pair of function templates. You should therefore write this macro only at namespace scope. </p>
 </div>
 </div>
 <div class="copyright-footer">Copyright © 2020 T. Zachary Laine<p>
@@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 </div>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="boost/parser/callback_parse_idm27388.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/parser_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/parser/parser_fwd_hpp.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="boost/parser/callback_parse_idm32854.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/parser_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/parser/parser_fwd_hpp.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/doc/html/BOOST_PARSER_DISA_idm22550.html → doc/html/BOOST_PARSER_DISA_idm29909.html b/doc/html/BOOST_PARSER_DISA_idm22550.html → doc/html/BOOST_PARSER_DISA_idm29909.html
@@ -7,15 +7,15 @@
 <link rel="home" href="index.html" title="Chapter 1. Boost.Parser (Proposed)">
 <link rel="up" href="header/boost/parser/config_hpp.html" title="Header &lt;boost/parser/config.hpp&gt;">
 <link rel="prev" href="BOOST_PARSER_ASSERT.html" title="Macro BOOST_PARSER_ASSERT">
-<link rel="next" href="BOOST_PARSER_DISA_idm22554.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
+<link rel="next" href="BOOST_PARSER_DISA_idm29913.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_ASSERT.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm22554.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_ASSERT.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm29913.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
-<a name="BOOST_PARSER_DISA_idm22550"></a><div class="titlepage"></div>
+<a name="BOOST_PARSER_DISA_idm29909"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Macro BOOST_PARSER_DISABLE_CONCEPTS</span></h2>
 <p>BOOST_PARSER_DISABLE_CONCEPTS</p>
@@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_DISABLE_CONCEPTS</pre></div>
 <div class="refsect1">
-<a name="idm21095"></a><h2>Description</h2>
+<a name="idm27866"></a><h2>Description</h2>
 <p>Boost.Parser will automatically use concepts to constrain templates when building in C++20 mode, if the compiler defines <code class="computeroutput">__cpp_lib_concepts</code>. To disable the use of concepts, define this macro. </p>
 </div>
 </div>
@@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 </div>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_ASSERT.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm22554.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_ASSERT.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_DISA_idm29913.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/doc/html/BOOST_PARSER_DISA_idm22554.html → doc/html/BOOST_PARSER_DISA_idm29913.html b/doc/html/BOOST_PARSER_DISA_idm22554.html → doc/html/BOOST_PARSER_DISA_idm29913.html
@@ -6,16 +6,16 @@
 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="Chapter 1. Boost.Parser (Proposed)">
 <link rel="up" href="header/boost/parser/config_hpp.html" title="Header &lt;boost/parser/config.hpp&gt;">
-<link rel="prev" href="BOOST_PARSER_DISA_idm22550.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
-<link rel="next" href="BOOST_PARSER_MAX__idm22559.html" title="Macro BOOST_PARSER_MAX_AGGREGATE_SIZE">
+<link rel="prev" href="BOOST_PARSER_DISA_idm29909.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
+<link rel="next" href="BOOST_PARSER_MAX__idm29918.html" title="Macro BOOST_PARSER_MAX_AGGREGATE_SIZE">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_DISA_idm22550.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_MAX__idm22559.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_DISA_idm29909.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_MAX__idm29918.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
-<a name="BOOST_PARSER_DISA_idm22554"></a><div class="titlepage"></div>
+<a name="BOOST_PARSER_DISA_idm29913"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Macro BOOST_PARSER_DISABLE_HANA_TUPLE</span></h2>
 <p>BOOST_PARSER_DISABLE_HANA_TUPLE</p>
@@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_DISABLE_HANA_TUPLE</pre></div>
 <div class="refsect1">
-<a name="idm21110"></a><h2>Description</h2>
+<a name="idm27881"></a><h2>Description</h2>
 <p>Define this macro to use <code class="computeroutput">std::tuple</code> instead of <code class="computeroutput">boost::hana::tuple</code> throughout Boost.Parser. </p>
 </div>
 </div>
@@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 </div>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_DISA_idm22550.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_MAX__idm22559.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_DISA_idm29909.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_MAX__idm29918.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/doc/html/BOOST_PARSER_MAX__idm22559.html → doc/html/BOOST_PARSER_MAX__idm29918.html b/doc/html/BOOST_PARSER_MAX__idm22559.html → doc/html/BOOST_PARSER_MAX__idm29918.html
@@ -6,16 +6,16 @@
 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="Chapter 1. Boost.Parser (Proposed)">
 <link rel="up" href="header/boost/parser/config_hpp.html" title="Header &lt;boost/parser/config.hpp&gt;">
-<link rel="prev" href="BOOST_PARSER_DISA_idm22554.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
+<link rel="prev" href="BOOST_PARSER_DISA_idm29913.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
 <link rel="next" href="BOOST_PARSER_SUBRANGE.html" title="Macro BOOST_PARSER_SUBRANGE">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_DISA_idm22554.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_SUBRANGE.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_DISA_idm29913.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_SUBRANGE.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
-<a name="BOOST_PARSER_MAX__idm22559"></a><div class="titlepage"></div>
+<a name="BOOST_PARSER_MAX__idm29918"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Macro BOOST_PARSER_MAX_AGGREGATE_SIZE</span></h2>
 <p>BOOST_PARSER_MAX_AGGREGATE_SIZE</p>
@@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_MAX_AGGREGATE_SIZE</pre></div>
 <div class="refsect1">
-<a name="idm21126"></a><h2>Description</h2>
+<a name="idm27897"></a><h2>Description</h2>
 <p>Boost.Parser automatically treats aggregate structs as if they were tuples. It uses some metaprogramming to do this. The technique used has a hard limit on the number of data members a struct can have. Re-define this macro to change the hard limit. Note that large values may increase compile times. </p>
 </div>
 </div>
@@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 </div>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="BOOST_PARSER_DISA_idm22554.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_SUBRANGE.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="BOOST_PARSER_DISA_idm29913.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_SUBRANGE.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/doc/html/BOOST_PARSER_NO_R_idm22538.html → doc/html/BOOST_PARSER_NO_R_idm29897.html b/doc/html/BOOST_PARSER_NO_R_idm22538.html → doc/html/BOOST_PARSER_NO_R_idm29897.html
@@ -15,7 +15,7 @@
 <a accesskey="p" href="header/boost/parser/config_hpp.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/parser/config_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_PARSER_ASSERT.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
-<a name="BOOST_PARSER_NO_R_idm22538"></a><div class="titlepage"></div>
+<a name="BOOST_PARSER_NO_R_idm29897"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Macro BOOST_PARSER_NO_RUNTIME_ASSERTIONS</span></h2>
 <p>BOOST_PARSER_NO_RUNTIME_ASSERTIONS</p>
@@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
 
 </span>BOOST_PARSER_NO_RUNTIME_ASSERTIONS</pre></div>
 <div class="refsect1">
-<a name="idm21062"></a><h2>Description</h2>
+<a name="idm27833"></a><h2>Description</h2>
 <p>Boost.Parser uses assertions (<code class="computeroutput">BOOST_ASSERT()</code>) in several places to indicate that your use of the library has an error in it. All of those places could heve instead been ill-formed code, caught at compile time. It is far quicker and easier to determine exactly where in your code such an error is located if this is a runtime failure; you can just look at the stack in your favorite debugger. However, if you want to make thes kinds of errors always ill-formed code, define this macro. </p>
 </div>
 </div>