various documentation corrections

Author: robertramey

doc/boostbook/motor.xml

@@ -23,7 +23,7 @@
   <section>
     <title>How a Stepper Motor Works</title>
 
-    <figure float="1">
+    <figure float="0">
       <title>Stepper Motor</title>
 
       <mediaobject>

doc/boostbook/safe.xml

@@ -123,7 +123,7 @@
             <entry><link linkend="safe_numerics.numeric"><link
             linkend="safe_numerics.promotion_policy">PromotionPolicy&lt;PP&gt;</link></link></entry>
 
-            <entry><para>Default value is <link
+            <entry><para>Optional promotion policy. Default value is <link
             linkend="safe_numerics.promotion_policies.native"><code>boost::numeric::native</code></link></para></entry>
           </row>
 
@@ -134,7 +134,7 @@
             linkend="safe_numerics.exception_policy">Exception
             Policy&lt;EP&gt;</link></link></entry>
 
-            <entry><para>Default value is <link
+            <entry><para>Optional exception policy. Default value is <link
             linkend="safe_numerics.exception_policies.default_exception_policy"><code>boost::numeric::default_exception_policy</code></link></para></entry>
           </row>
         </tbody>

doc/boostbook/safe_literal.xml

@@ -96,7 +96,8 @@
             <entry><link linkend="safe_numerics.numeric"><link
             linkend="safe_numerics.promotion_policy">PromotionPolicy&lt;PP&gt;</link></link></entry>
 
-            <entry><para>Default value is <code>void</code></para></entry>
+            <entry><para>Optional promotion policy. Default value is
+            <code>void</code></para></entry>
           </row>
 
           <row>
@@ -106,7 +107,8 @@
             linkend="safe_numerics.exception_policy">Exception
             Policy&lt;EP&gt;</link></link></entry>
 
-            <entry><para>Default value is <code>void</code></para></entry>
+            <entry><para>Optional exception policy. Default value is
+            <code>void</code></para></entry>
           </row>
         </tbody>
       </tgroup>
@@ -117,9 +119,9 @@
     <title>Inherited Valid Expressions</title>
 
     <para>safe literal types are immutable. Hence they only inherit those
-    valid expressions which don't change the value. This excludes assignment,
-    increment, and decrement and all unary operators except unary -, + and ~.
-    Other than that, they can be used anywhere a <link
+    valid expressions which don't change the value. <emphasis>This excludes
+    assignment, increment, and decrement and all unary operators except unary
+    -, + and ~</emphasis>. Other than that, they can be used anywhere a <link
     linkend="safe_numerics.safe_numeric_concept">SafeNumeric</link> type can
     be used. Note that the default promotion and exception policies are void.
     This is usually convenient since when a safe literal is used in a binary
@@ -145,121 +147,10 @@ constexpr safe&lt;int&gt; z = x / y;
 </programlisting></para>
   </section>
 
-  <section>
-    <title>Valid Expression</title>
-
-    <para><informaltable>
-        <tgroup cols="3">
-          <colspec align="left" colwidth="1*"/>
-
-          <colspec align="left" colwidth="1*"/>
-
-          <colspec align="left" colwidth="3*"/>
-
-          <thead>
-            <row>
-              <entry align="left">Expression</entry>
-
-              <entry align="left">Result Type</entry>
-
-              <entry>Description</entry>
-            </row>
-          </thead>
-
-          <tbody>
-            <row>
-              <entry><code>t op s</code></entry>
-
-              <entry>unspecified S</entry>
-
-              <entry><para>invoke C++ operator op and return another
-              SafeNumeric type.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>s1 op s2</code></entry>
-
-              <entry>unspecified S</entry>
-
-              <entry><para>invoke C++ operator op and return another
-              SafeNumeric type.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>prefix_op S</code></entry>
-
-              <entry>unspecified S</entry>
-
-              <entry><para>invoke C++ operator <code>prefix_op</code> and
-              return another SafeNumeric type.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>S postfix_op</code></entry>
-
-              <entry>unspecified S</entry>
-
-              <entry><para>invoke C++ operator <code>postfix_op</code> and
-              return another SafeNumeric type.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>s assign_op t</code></entry>
-
-              <entry>S1</entry>
-
-              <entry><para>convert t to type S and assign it to s. If the
-              value t cannot be represented as an instance of type S, it is an
-              error.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>S(t)</code></entry>
-
-              <entry>unspecified S</entry>
-
-              <entry><para>construct an instance of S from a value of type T.
-              If the value t cannot be represented as an instance of type S,
-              it is an error.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>S</code></entry>
-
-              <entry>S</entry>
-
-              <entry><para>construct an uninitialized instance of
-              S.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>is_safe&lt;S&gt;</code></entry>
-
-              <entry><code>std::true_type</code> or
-              <code>std::false_type</code></entry>
-
-              <entry><para>type trait to query whether any type S fulfills the
-              requirements for a SafeNumeric type.</para></entry>
-            </row>
-
-            <row>
-              <entry><code>static_cast&lt;T&gt;(s)</code></entry>
-
-              <entry>T</entry>
-
-              <entry><para>convert the value of s to type T. If the value of s
-              cannot be correctly represented as a type T, it is an error.
-              </para></entry>
-            </row>
-          </tbody>
-        </tgroup>
-      </informaltable></para>
-  </section>
-
   <section>
     <title>Example of use</title>
 
-    <programlisting>#include &lt;boost/numeric/safe_numerics/safe_literal.hpp&gt;
+    <programlisting><ulink url="../../include/safe_integer_literal.hpp">#include &lt;boost/numeric/safe_numerics/safe_integer_literal.hpp&gt;</ulink>
 
 constexpr boost::numeric::safe_signed_literal&lt;42&gt; x;
 </programlisting>
@@ -276,7 +167,7 @@ constexpr boost::numeric::safe_signed_literal&lt;42&gt; x;
   <section>
     <title>Header</title>
 
-    <para><ulink url="../../include/safe_literal.hpp">#include
-    &lt;boost/numeric/safe_numerics/safe_literal.hpp&gt;</ulink></para>
+    <para><ulink url="../../include/safe_integer_literal.hpp">#include
+    &lt;boost/numeric/safe_numerics/safe_integer_literal.hpp&gt;</ulink></para>
   </section>
 </section>

doc/html/bibliography.html

@@ -21,7 +21,7 @@
 <a name="safe_numerics.bibliography"></a>Bibliography</h2></div></div></div>
 <div class="bibliography">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="idm450398272592"></a>Bibliography</h3></div></div></div>
+<a name="idm63514675872"></a>Bibliography</h3></div></div></div>
 <div class="biblioentry">
 <a name="coker"></a><p>[<abbr class="abbrev">Coker</abbr>] <span class="author"><span class="firstname">Zack</span> <span class="surname">Coker</span>. </span><span class="author"><span class="firstname">Samir</span> <span class="surname">Hasan</span>. </span><span class="author"><span class="firstname">Jeffrey</span> <span class="surname">Overbey</span>. </span><span class="author"><span class="firstname">Munawar</span> <span class="surname">Hafiz</span>. </span><span class="author"><span class="firstname">Christian</span> <span class="surname">K&#228;stner</span>. </span><span class="title"><i>
         <a href="http://www.cert.org/secure-coding/publications/books/secure-coding-c-c-second-edition.cfm?" target="_top">

doc/html/checked_arithmetic.html

@@ -21,43 +21,43 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="safe_numerics.checked_arithmetic"></a>Checked Arithmetic</h3></div></div></div>
 <div class="toc"><dl class="toc">
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399112032">Description</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399110704">Type requirements</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399108704">Complexity</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399107552">Example of use</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399090288">Notes</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450399088720">Synopsis</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450398844080">See Also</a></span></dt>
-<dt><span class="section"><a href="checked_arithmetic.html#idm450398842352">Header</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514893328">Description</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514892000">Type requirements</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514890000">Complexity</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514888848">Example of use</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514871584">Notes</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63514869616">Synopsis</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63523346416">See Also</a></span></dt>
+<dt><span class="section"><a href="checked_arithmetic.html#idm63523344912">Header</a></span></dt>
 </dl></div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399112032"></a>Description</h4></div></div></div>
+<a name="idm63514893328"></a>Description</h4></div></div></div>
 <p>Perform binary operations on arithmetic types. Return either a valid
     result or an error code. Under no circumstances should an incorrect result
     be returned.</p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399110704"></a>Type requirements</h4></div></div></div>
+<a name="idm63514892000"></a>Type requirements</h4></div></div></div>
 <p>All template parameters of the functions must model <a class="link" href="integer.html" title="Integer&lt;T&gt;">Numeric</a> type requirements.</p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399108704"></a>Complexity</h4></div></div></div>
+<a name="idm63514890000"></a>Complexity</h4></div></div></div>
 <p>Each function performs one and only one arithmetic operation.</p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399107552"></a>Example of use</h4></div></div></div>
+<a name="idm63514888848"></a>Example of use</h4></div></div></div>
 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">/</span><span class="identifier">safe_numerics</span><span class="special">/</span><span class="identifier">checked_default</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 
 <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">r</span> <span class="special">=</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">multiply</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span><span class="special">(</span><span class="number">24</span><span class="special">,</span> <span class="number">42</span><span class="special">)</span><span class="special">;</span>
 </pre>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399090288"></a>Notes</h4></div></div></div>
+<a name="idm63514871584"></a>Notes</h4></div></div></div>
 <p>Some compilers have command line switches (e.g. -ftrapv) which
     enable special behavior such that erroneous integer operations are
     detected at run time. The library has been implemented in such a way that
@@ -67,7 +67,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450399088720"></a>Synopsis</h4></div></div></div>
+<a name="idm63514869616"></a>Synopsis</h4></div></div></div>
 <pre class="programlisting"><span class="comment">// safe casting on primitive types</span>
 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
 <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">cast</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">)</span><span class="special">;</span>
@@ -133,12 +133,12 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398844080"></a>See Also</h4></div></div></div>
+<a name="idm63523346416"></a>See Also</h4></div></div></div>
 <p><a class="link" href="checked_result.html" title="checked_result&lt;R&gt;">checked_result&lt;R&gt;</a></p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398842352"></a>Header</h4></div></div></div>
+<a name="idm63523344912"></a>Header</h4></div></div></div>
 <p><a href="../../include/checked.hpp" target="_top"><code class="computeroutput">#include
     &lt;boost/numeric/safe_numerics/checked_default.hpp&gt;
     </code></a></p>

doc/html/checked_integer_arithmetic.html

@@ -21,16 +21,16 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="safe_numerics.checked_integer_arithmetic"></a>safe_compare&lt;T, U&gt;</h3></div></div></div>
 <div class="toc"><dl class="toc">
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398629472">Synopsis</a></span></dt>
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398541296">Description</a></span></dt>
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398533952">Type requirements</a></span></dt>
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398530448">Complexity</a></span></dt>
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398529216">Example of use</a></span></dt>
-<dt><span class="section"><a href="checked_integer_arithmetic.html#idm450398498560">Header</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523147904">Synopsis</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523063424">Description</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523056992">Type requirements</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523053824">Complexity</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523052608">Example of use</a></span></dt>
+<dt><span class="section"><a href="checked_integer_arithmetic.html#idm63523023200">Header</a></span></dt>
 </dl></div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398629472"></a>Synopsis</h4></div></div></div>
+<a name="idm63523147904"></a>Synopsis</h4></div></div></div>
 <pre class="programlisting"><span class="comment">// compare any pair of integers</span>
 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">&gt;</span>
 <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">safe_compare</span><span class="special">::</span><span class="identifier">less_than</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> <span class="identifier">lhs</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">)</span><span class="special">;</span>
@@ -52,7 +52,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398541296"></a>Description</h4></div></div></div>
+<a name="idm63523063424"></a>Description</h4></div></div></div>
 <p>Compare two primitive integers. These functions will return a
     correct result regardless of the type of the operands. Specifically it is
     guaranteed to return the correct arithmetic result when comparing signed
@@ -67,19 +67,19 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398533952"></a>Type requirements</h4></div></div></div>
+<a name="idm63523056992"></a>Type requirements</h4></div></div></div>
 <p>All template parameters of the functions must be C/C++ built-in
     integer types, <code class="computeroutput"><code class="computeroutput">char</code></code>,
     <code class="computeroutput"><code class="computeroutput">int</code></code> ....</p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398530448"></a>Complexity</h4></div></div></div>
+<a name="idm63523053824"></a>Complexity</h4></div></div></div>
 <p>Each function performs one and only one arithmetic operation.</p>
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398529216"></a>Example of use</h4></div></div></div>
+<a name="idm63523052608"></a>Example of use</h4></div></div></div>
 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">cassert</span><span class="special">&gt;</span>
 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">safe_compare</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 
@@ -92,7 +92,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="idm450398498560"></a>Header</h4></div></div></div>
+<a name="idm63523023200"></a>Header</h4></div></div></div>
 <p><a href="../../include/safe_compare.hpp" target="_top"><code class="computeroutput">#include
     &lt;boost/numeric/safe_numerics/safe_compare.hpp&gt;
     </code></a></p>