Add missing docs for lyra::val.

bfgroup · Aug 27, 2020 · 85332b0 · 85332b0
1 parent a596e9a
commit 85332b0
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/data/single_include/lyra/lyra.hpp b/data/single_include/lyra/lyra.hpp
@@ -1151,6 +1151,17 @@ namespace lyra {
 [#lyra_val]
 = `lyra::val`
 
+[source]
+----
+auto val(T && v);
+auto val(const char * v);
+----
+
+Makes a bound self-contained value of the type of the given r-value. The created
+bound values can be used in place of the value references for arguments. And can
+be retrieved with the
+<<lyra_cli_array_ref>> call.
+
 */ // end::reference[]
 template <typename T>
 detail::BoundVal<T> val(T && v)

diff --git a/docs/lyra.html b/docs/lyra.html
@@ -2349,7 +2349,18 @@ <h4 id="lyra_main_execute"><a class="anchor" href="#lyra_main_execute"></a>11.17
 </div>
 <div class="sect2">
 <h3 id="lyra_val"><a class="anchor" href="#lyra_val"></a>11.18. <code>lyra::val</code></h3>
-
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="c++"><span></span><span class="tok-k">auto</span> <span class="tok-nf">val</span><span class="tok-p">(</span><span class="tok-n">T</span> <span class="tok-o">&amp;&amp;</span> <span class="tok-n">v</span><span class="tok-p">);</span>
+<span class="tok-k">auto</span> <span class="tok-nf">val</span><span class="tok-p">(</span><span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span> <span class="tok-n">v</span><span class="tok-p">);</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Makes a bound self-contained value of the type of the given r-value. The created
+bound values can be used in place of the value references for arguments. And can
+be retrieved with the
+<a href="#lyra_cli_array_ref"><code>lyra::cli::operator[]</code></a> call.</p>
+</div>
 </div>
 </div>
 </div>

diff --git a/include/lyra/val.hpp b/include/lyra/val.hpp
@@ -16,6 +16,17 @@ namespace lyra {
 [#lyra_val]
 = `lyra::val`
 
+[source]
+----
+auto val(T && v);
+auto val(const char * v);
+----
+
+Makes a bound self-contained value of the type of the given r-value. The created
+bound values can be used in place of the value references for arguments. And can
+be retrieved with the
+<<lyra_cli_array_ref>> call.
+
 */ // end::reference[]
 template <typename T>
 detail::BoundVal<T> val(T && v)