Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / contract / doc / html / boost / contract / access.html

diff --git a/libs/contract/doc/html/boost/contract/access.html b/libs/contract/doc/html/boost/contract/access.html
index 287fddb..55eaa4c 100644 (file)
--- a/libs/contract/doc/html/boost/contract/access.html
+++ b/libs/contract/doc/html/boost/contract/access.html
@@ -26,7 +26,7 @@
 <a name="boost.contract.access"></a><div class="titlepage"></div>
 <div class="refnamediv">
 <h2><span class="refentrytitle">Class access</span></h2>
-<p>boost::contract::access &#8212; Friend this class to declare invariants and base types as private members. </p>
+<p>boost::contract::access &#8212; Declare this class as friend to program invariants and base types as private members. </p>
 </div>
 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../reference.html#header.boost.contract.core.access_hpp" title="Header &lt;boost/contract/core/access.hpp&gt;">boost/contract/core/access.hpp</a>&gt;
@@ -35,30 +35,30 @@
 <span class="keyword">class</span> <a class="link" href="access.html" title="Class access">access</a> <span class="special">{</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm45751730610208"></a><h2>Description</h2>
-<p>Declare this class a friend of the user-defined class specifying the contracts in order to declare the invariant functions and the base types <code class="computeroutput">typedef</code> as non-public members:</p>
-<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span> <span class="special">:</span>
+<a name="idm45707997160096"></a><h2>Description</h2>
+<p>Declare this class a friend of the user-defined class specifying the contracts and then invariant functions and the base types <code class="computeroutput">typedef</code> can be declared as non-public members:</p>
+<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span>
     <span class="preprocessor">#define</span> <span class="identifier">BASES</span> <span class="keyword">public</span> <span class="identifier">b</span><span class="special">,</span> <span class="keyword">private</span> <span class="identifier">w</span>
-    <span class="identifier">BASES</span>
+    <span class="special">:</span> <span class="identifier">BASES</span>
 <span class="special">{</span>
     <span class="keyword">friend</span> <span class="keyword">class</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">access</span><span class="special">;</span>
 
-    <span class="keyword">typedef</span> <span class="identifier">BOOST_CONTRACT_BASES</span><span class="special">(</span><span class="identifier">BASES</span><span class="special">)</span> <span class="identifier">base_types</span><span class="special">;</span> <span class="comment">// Private.</span>
+    <span class="keyword">typedef</span> <span class="identifier">BOOST_CONTRACT_BASE_TYPES</span><span class="special">(</span><span class="identifier">BASES</span><span class="special">)</span> <span class="identifier">base_types</span><span class="special">;</span> <span class="comment">// Private.</span>
     <span class="preprocessor">#undef</span> <span class="identifier">BASES</span>
 
-    <span class="keyword">void</span> <span class="identifier">invariant</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="special">...</span> <span class="special">}</span> <span class="comment">// Private.</span>
+    <span class="keyword">void</span> <span class="identifier">invariant</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="special">...</span> <span class="special">}</span> <span class="comment">// Private (same for static and volatile).</span>
 
 <span class="keyword">public</span><span class="special">:</span>
     <span class="special">...</span>
 <span class="special">}</span><span class="special">;</span>
 </pre>
-<p>In real code, programmers will likely chose to declare this class as friend so to fully control public interfaces of their user-defined classes. This class is not intended to be directly used by programmers a part from declaring it <code class="computeroutput">friend</code> (and that is why this class does not have any public member and it is not copyable).</p>
+<p>In real code, programmers will likely chose to declare this class as friend so to fully control public interfaces of their user-defined classes (this is not extensively done in the examples of this documentation only for brevity). This class is not intended to be directly used by programmers a part from being declared as <code class="computeroutput">friend</code> (and that is why this class does not have any public member and it is not copyable).</p>
 <div class="warning"><table border="0" summary="Warning">
 <tr>
 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/src/images/warning.png"></td>
 <th align="left">Warning</th>
 </tr>
-<tr><td align="left" valign="top"><p>Not declaring this class friend of user-defined classes will cause compiler errors on some compilers (e.g., MSVC) because the private members needed to check the contracts will not be accessible. On other compilers (e.g., GCC and CLang), the private access will instead fail SFINAE and no compiler error will be reported while invariants and subcontracting will be silently skipped at run-time. Therefore, programmers must make sure to either declare this class as friend (preferred) or to always declare invariant functions and base types <code class="computeroutput">typedef</code> as public members.</p></td></tr>
+<tr><td align="left" valign="top"><p>Not declaring this class friend of user-defined classes will cause compiler errors on some compilers (e.g., MSVC) because the private members needed to check the contracts will not be accessible. On other compilers (e.g., GCC and CLang), the private access will instead fail SFINAE and no compiler error will be reported while invariants and subcontracting will be silently skipped at run-time. Therefore, programmers must make sure to either declare this class as friend or to always declare invariant functions and base types <code class="computeroutput">typedef</code> as public members.</p></td></tr>
 </table></div>
 <p>
 </p>
@@ -72,7 +72,7 @@
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright &#169; 2008-2018 Lorenzo Caminiti<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
         Distributed under the Boost Software License, Version 1.0 (see accompanying
         file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
       </p>