1 | <html> |
---|
2 | <head> |
---|
3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
---|
4 | <title> |
---|
5 | BoostBook element method</title> |
---|
6 | <link rel="stylesheet" href="../../boostbook.css" type="text/css"> |
---|
7 | <meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> |
---|
8 | <link rel="start" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
---|
9 | <link rel="up" href="../../reference.html" title="Reference"> |
---|
10 | <link rel="prev" href="compile-test.html" title=" |
---|
11 | BoostBook element compile-test"> |
---|
12 | <link rel="next" href="snippet.html" title=" |
---|
13 | BoostBook element snippet"> |
---|
14 | </head> |
---|
15 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
---|
16 | <table cellpadding="2" width="100%"> |
---|
17 | <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
---|
18 | <td align="center"><a href="../../../../index.htm">Home</a></td> |
---|
19 | <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
---|
20 | <td align="center"><a href="../../../../people/people.htm">People</a></td> |
---|
21 | <td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> |
---|
22 | <td align="center"><a href="../../../../more/index.htm">More</a></td> |
---|
23 | </table> |
---|
24 | <hr> |
---|
25 | <div class="spirit-nav"> |
---|
26 | <a accesskey="p" href="compile-test.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="snippet.html"><img src="../../images/next.png" alt="Next"></a> |
---|
27 | </div> |
---|
28 | <div class="refentry" lang="en"> |
---|
29 | <a name="boostbook.dtd.method"></a><div class="titlepage"></div> |
---|
30 | <div class="refnamediv"> |
---|
31 | <h2><span class="refentrytitle"> |
---|
32 | BoostBook element <code class="sgmltag-element">method</code></span></h2> |
---|
33 | <p>method — Declares a method, i.e., a member function</p> |
---|
34 | </div> |
---|
35 | <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
---|
36 | <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">method ::= |
---|
37 | (<a href="template.html" title=" |
---|
38 | BoostBook element template">template</a>?, <a href="type.html" title=" |
---|
39 | BoostBook element type">type</a>, <a href="parameter.html" title=" |
---|
40 | BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" |
---|
41 | BoostBook element purpose">purpose</a>?, <a href="description.html" title=" |
---|
42 | BoostBook element description">description</a>?, <a href="requires.html" title=" |
---|
43 | BoostBook element requires">requires</a>?, <a href="effects.html" title=" |
---|
44 | BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" |
---|
45 | BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" |
---|
46 | BoostBook element returns">returns</a>?, <a href="throws.html" title=" |
---|
47 | BoostBook element throws">throws</a>?, <a href="complexity.html" title=" |
---|
48 | BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" |
---|
49 | BoostBook element notes">notes</a>?, <a href="rationale.html" title=" |
---|
50 | BoostBook element rationale">rationale</a>?) |
---|
51 | </div> |
---|
52 | <div class="refsection" lang="en"> |
---|
53 | <a name="id2060922"></a><h2>Description</h2> |
---|
54 | <p>General documentation on functions in BoostBook is provided in |
---|
55 | the <a href="function.html" title=" |
---|
56 | BoostBook element function"><code class="sgmltag-element">function</code></a> |
---|
57 | element documentation.</p> |
---|
58 | </div> |
---|
59 | <div class="refsection" lang="en"> |
---|
60 | <a name="id2060940"></a> |
---|
61 | <h2>Attributes</h2> |
---|
62 | <div class="informaltable"><table class="table"> |
---|
63 | <colgroup> |
---|
64 | <col> |
---|
65 | <col> |
---|
66 | <col> |
---|
67 | <col> |
---|
68 | </colgroup> |
---|
69 | <thead><tr> |
---|
70 | <th>Name</th> |
---|
71 | <th>Type</th> |
---|
72 | <th>Value</th> |
---|
73 | <th>Purpose</th> |
---|
74 | </tr></thead> |
---|
75 | <tbody> |
---|
76 | <tr> |
---|
77 | <td>last-revision</td> |
---|
78 | <td>#IMPLIED</td> |
---|
79 | <td>CDATA</td> |
---|
80 | <td>Set to $Date: 2006/11/03 19:39:44 $ to keep "last revised" information in sync with CVS changes</td> |
---|
81 | </tr> |
---|
82 | <tr> |
---|
83 | <td>cv</td> |
---|
84 | <td>#IMPLIED</td> |
---|
85 | <td>CDATA</td> |
---|
86 | <td>cv-qualifiers for this method, e.g., const volatile</td> |
---|
87 | </tr> |
---|
88 | <tr> |
---|
89 | <td>specifiers</td> |
---|
90 | <td>#IMPLIED</td> |
---|
91 | <td>CDATA</td> |
---|
92 | <td>The specifiers for this function, e.g., inline, static, etc.</td> |
---|
93 | </tr> |
---|
94 | <tr> |
---|
95 | <td>name</td> |
---|
96 | <td>#REQUIRED</td> |
---|
97 | <td>CDATA</td> |
---|
98 | <td>The name of the element being declared to referenced</td> |
---|
99 | </tr> |
---|
100 | <tr> |
---|
101 | <td>id</td> |
---|
102 | <td>#IMPLIED</td> |
---|
103 | <td>CDATA</td> |
---|
104 | <td>A global identifier for this element</td> |
---|
105 | </tr> |
---|
106 | <tr> |
---|
107 | <td>xml:base</td> |
---|
108 | <td>#IMPLIED</td> |
---|
109 | <td>CDATA</td> |
---|
110 | <td>Implementation detail used by XIncludes</td> |
---|
111 | </tr> |
---|
112 | </tbody> |
---|
113 | </table></div> |
---|
114 | </div> |
---|
115 | </div> |
---|
116 | <table width="100%"><tr> |
---|
117 | <td align="left"></td> |
---|
118 | <td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> |
---|
119 | </tr></table> |
---|
120 | <hr> |
---|
121 | <div class="spirit-nav"> |
---|
122 | <a accesskey="p" href="compile-test.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="snippet.html"><img src="../../images/next.png" alt="Next"></a> |
---|
123 | </div> |
---|
124 | </body> |
---|
125 | </html> |
---|