diff options
Diffstat (limited to 'doc/html/boostbook/dtd/function.html')
| -rw-r--r-- | doc/html/boostbook/dtd/function.html | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/doc/html/boostbook/dtd/function.html b/doc/html/boostbook/dtd/function.html new file mode 100644 index 0000000000..9d8f87ade1 --- /dev/null +++ b/doc/html/boostbook/dtd/function.html @@ -0,0 +1,165 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element function</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="source.html" title=" + BoostBook element source"> +<link rel="next" href="postconditions.html" title=" + BoostBook element postconditions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.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="postconditions.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.function"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">function</code></span></h2> +<p>function — Declares a function</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">function ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="type.html" title=" + BoostBook element type">type</a>, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id2846870"></a><h2>Description</h2> +<p>BoostBook functions are documented by specifying the + function's interface (e.g., its C++ signature) and its + behavior. Constructors, destructors, member functions, and free + functions all use the same documentation method, although the + top-level tags differ.</p> +<p>The behavior of functions in BoostBook is documenting using a + style similar to that of the C++ standard, with clauses describing + the requirements, effects, postconditions, exception behavior, and + return values of functions.</p> +<p>The following example illustrates some constructors and a + destructor for <code class="computeroutput"><a href="../../boost/any.html" title="Class any">boost::any</a></code>. Note that one of + the constructors takes a single parameter whose name is "other" and + whose type, <code class="computeroutput">const any&</code> is contained in the + <paramtype> element; any number of parameters may be specified + in this way.</p> +<pre class="programlisting"><class name="any"> + <constructor> + <postconditions><para><this->empty()></para></postconditions> + </constructor> + + <constructor> + <parameter name="other"> + <paramtype>const <classname>any</classname>&amp;</paramtype> + </parameter> + + <effects> + <simpara> Copy constructor that copies + content of <code>other</code> into the new instance, + so that any content is equivalent in both type and value to the + content of <code>other</code>, or empty if + <code>other</code> is + empty. + </simpara> + </effects> + + <throws> + <simpara>May fail with a + <classname>std::bad_alloc</classname> exception or any + exceptions arising from the copy constructor of the + contained type. + </simpara> + </throws> + </constructor> + + <destructor> + <effects><simpara>Releases any and all resources used in + management of instance.</simpara></effects> + + <throws><simpara>Nothing.</simpara></throws> + </destructor> +</class></pre> +</div> +<div class="refsection" lang="en"> +<a name="id2846949"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.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="postconditions.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> |