Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tzlaine committed Jan 8, 2024
1 parent ca6e5a1 commit 877fb64
Show file tree
Hide file tree
Showing 210 changed files with 1,300 additions and 1,300 deletions.
10 changes: 5 additions & 5 deletions doc/html/BOOST_PARSER_ASSERT.html
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm16918.html" title="Macro BOOST_PARSER_NO_RUNTIME_ASSERTIONS">
<link rel="next" href="BOOST_PARSER_DISA_idm16930.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
<link rel="prev" href="BOOST_PARSER_NO_R_idm16917.html" title="Macro BOOST_PARSER_NO_RUNTIME_ASSERTIONS">
<link rel="next" href="BOOST_PARSER_DISA_idm16929.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_idm16918.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_idm16930.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="BOOST_PARSER_NO_R_idm16917.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_idm16929.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_PARSER_ASSERT"></a><div class="titlepage"></div>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_ASSERT(condition)</pre></div>
<div class="refsect1">
<a name="idm16032"></a><h2>Description</h2>
<a name="idm16031"></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>
Expand All @@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_PARSER_NO_R_idm16918.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_idm16930.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="BOOST_PARSER_NO_R_idm16917.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_idm16929.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/html/BOOST_PARSER_DEFINE_RULE.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_DEFINE_RULE(rule)</pre></div>
<div class="refsect1">
<a name="idm34630"></a><h2>Description</h2>
<a name="idm34629"></a><h2>Description</h2>
<p>Defines a pair of <code class="computeroutput">parse_rule()</code> overloads for the given rule, used internally within Boost.Parser. The pair implements the parsing behavior rule <code class="computeroutput">rule</code>, using the parser <code class="computeroutput">rule_def</code>. </p>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions doc/html/BOOST_PARSER_DEFINE_RULES.html
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm21534.html" title="Function template callback_parse">
<link rel="prev" href="boost/parser/callback_parse_idm21533.html" title="Function template callback_parse">
<link rel="next" href="BOOST_PARSER_DEFINE_RULE.html" title="Macro BOOST_PARSER_DEFINE_RULE">
<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_idm21534.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="BOOST_PARSER_DEFINE_RULE.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="boost/parser/callback_parse_idm21533.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="BOOST_PARSER_DEFINE_RULE.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_PARSER_DEFINE_RULES"></a><div class="titlepage"></div>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_DEFINE_RULES(...)</pre></div>
<div class="refsect1">
<a name="idm34612"></a><h2>Description</h2>
<a name="idm34611"></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>
</div>
</div>
Expand All @@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/parser/callback_parse_idm21534.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="BOOST_PARSER_DEFINE_RULE.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="boost/parser/callback_parse_idm21533.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="BOOST_PARSER_DEFINE_RULE.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm16934.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
<link rel="next" href="BOOST_PARSER_DISA_idm16933.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_idm16934.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_idm16933.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_PARSER_DISA_idm16930"></a><div class="titlepage"></div>
<a name="BOOST_PARSER_DISA_idm16929"></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>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_DISABLE_CONCEPTS</pre></div>
<div class="refsect1">
<a name="idm16050"></a><h2>Description</h2>
<a name="idm16049"></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>
Expand All @@ -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_idm16934.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_idm16933.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm16930.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
<link rel="next" href="BOOST_PARSER_MAX__idm16939.html" title="Macro BOOST_PARSER_MAX_AGGREGATE_SIZE">
<link rel="prev" href="BOOST_PARSER_DISA_idm16929.html" title="Macro BOOST_PARSER_DISABLE_CONCEPTS">
<link rel="next" href="BOOST_PARSER_MAX__idm16938.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_idm16930.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__idm16939.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="BOOST_PARSER_DISA_idm16929.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__idm16938.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_PARSER_DISA_idm16934"></a><div class="titlepage"></div>
<a name="BOOST_PARSER_DISA_idm16933"></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>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_DISABLE_HANA_TUPLE</pre></div>
<div class="refsect1">
<a name="idm16065"></a><h2>Description</h2>
<a name="idm16064"></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>
Expand All @@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_PARSER_DISA_idm16930.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__idm16939.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="BOOST_PARSER_DISA_idm16929.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__idm16938.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm16934.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
<link rel="prev" href="BOOST_PARSER_DISA_idm16933.html" title="Macro BOOST_PARSER_DISABLE_HANA_TUPLE">
<link rel="next" href="BOOST_PARSER_USE_CONCEPTS.html" title="Macro BOOST_PARSER_USE_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_DISA_idm16934.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>
<a accesskey="p" href="BOOST_PARSER_DISA_idm16933.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_MAX__idm16939"></a><div class="titlepage"></div>
<a name="BOOST_PARSER_MAX__idm16938"></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>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_MAX_AGGREGATE_SIZE</pre></div>
<div class="refsect1">
<a name="idm16081"></a><h2>Description</h2>
<a name="idm16080"></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>
Expand All @@ -36,7 +36,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_PARSER_DISA_idm16934.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>
<a accesskey="p" href="BOOST_PARSER_DISA_idm16933.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>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -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_idm16918"></a><div class="titlepage"></div>
<a name="BOOST_PARSER_NO_R_idm16917"></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>
Expand All @@ -25,7 +25,7 @@ <h2 class="refsynopsisdiv-title">Synopsis</h2>

</span>BOOST_PARSER_NO_RUNTIME_ASSERTIONS</pre></div>
<div class="refsect1">
<a name="idm16017"></a><h2>Description</h2>
<a name="idm16016"></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>
Expand Down
Loading

0 comments on commit 877fb64

Please sign in to comment.