public/elisp-vcs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
elisp-vcs/doxymacs/example/doc/html/classFoo.html

220 lines
11 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Test project: Foo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Foo Class Reference</h1><!-- doxytag: class="Foo" -->
<p>This class does <a class="el" href="structblah.html" title="This struct does something useless.">blah</a>.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="aclass_8h_source.html">aclass.h</a>&gt;</code></p>
<p><a href="classFoo-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862c">blah_blah</a> { <a class="el" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862ca551af527291c62badc07f5731648c7ed">BAZ</a>,
<a class="el" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862cacba6ac26da56f9234ebf45f6398cb9c0">BAZ2</a>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoo.html#a400553bba3f44d1d4b82a0be2bf575b6">Foo</a> (int <a class="el" href="structblah.html">blah</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <a href="#a400553bba3f44d1d4b82a0be2bf575b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoo.html#a1d524237312eaafba8838e9c354df460">GetBlah</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current value of <a class="el" href="structblah.html" title="This struct does something useless.">blah</a>. <a href="#a1d524237312eaafba8838e9c354df460"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoo.html#aefff6cbdd4727b0b1da2c7c00f529a02">Foo</a> (int &amp;in, int &amp;out, int &amp;inout)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Testing the in/out parameter stuff. <a href="#aefff6cbdd4727b0b1da2c7c00f529a02"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFoo.html#a4e5ef452fe3f664199e8c5e91754e0e2">_blah</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is a measure of our blahness. <a href="#a4e5ef452fe3f664199e8c5e91754e0e2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class does <a class="el" href="structblah.html" title="This struct does something useless.">blah</a>. </p>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00013">13</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a9fbd006a5c0ff9ddb4f02a950d4e862c"></a><!-- doxytag: member="Foo::blah_blah" ref="a9fbd006a5c0ff9ddb4f02a950d4e862c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862c">Foo::blah_blah</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a9fbd006a5c0ff9ddb4f02a950d4e862ca551af527291c62badc07f5731648c7ed"></a><!-- doxytag: member="BAZ" ref="a9fbd006a5c0ff9ddb4f02a950d4e862ca551af527291c62badc07f5731648c7ed" args="" -->BAZ</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9fbd006a5c0ff9ddb4f02a950d4e862cacba6ac26da56f9234ebf45f6398cb9c0"></a><!-- doxytag: member="BAZ2" ref="a9fbd006a5c0ff9ddb4f02a950d4e862cacba6ac26da56f9234ebf45f6398cb9c0" args="" -->BAZ2</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00030">30</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <a class="code" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862ca551af527291c62badc07f5731648c7ed">BAZ</a>,
<a name="l00033"></a>00033 <a class="code" href="classFoo.html#a9fbd006a5c0ff9ddb4f02a950d4e862cacba6ac26da56f9234ebf45f6398cb9c0">BAZ2</a>,
<a name="l00034"></a>00034 };
</pre></div></p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a400553bba3f44d1d4b82a0be2bf575b6"></a><!-- doxytag: member="Foo::Foo" ref="a400553bba3f44d1d4b82a0be2bf575b6" args="(int blah)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Foo::Foo </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>blah</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="structblah.html" title="This struct does something useless.">blah</a></em>&nbsp;</td><td>Some kind of fish. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00021">21</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00022"></a>00022 : <a class="code" href="classFoo.html#a4e5ef452fe3f664199e8c5e91754e0e2" title="This is a measure of our blahness.">_blah</a>(<a class="code" href="structblah.html" title="This struct does something useless.">blah</a>)
<a name="l00023"></a>00023 {}
</pre></div></p>
</div>
</div>
<a class="anchor" id="aefff6cbdd4727b0b1da2c7c00f529a02"></a><!-- doxytag: member="Foo::Foo" ref="aefff6cbdd4727b0b1da2c7c00f529a02" args="(int &amp;in, int &amp;out, int &amp;inout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Foo::Foo </td>
<td>(</td>
<td class="paramtype">int &amp;&nbsp;</td>
<td class="paramname"> <em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&nbsp;</td>
<td class="paramname"> <em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;&nbsp;</td>
<td class="paramname"> <em>inout</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Testing the in/out parameter stuff. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>in</em>&nbsp;</td><td>An "in" parameter </td></tr>
<tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>out</em>&nbsp;</td><td>An "out" parameter </td></tr>
<tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>inout</em>&nbsp;</td><td>An "inout" parameter </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00045">45</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00045"></a>00045 { out = in + inout; }
</pre></div></p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1d524237312eaafba8838e9c354df460"></a><!-- doxytag: member="Foo::GetBlah" ref="a1d524237312eaafba8838e9c354df460" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Foo::GetBlah </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current value of <a class="el" href="structblah.html" title="This struct does something useless.">blah</a>. </p>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00028">28</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00028"></a>00028 { <span class="keywordflow">return</span> <a class="code" href="aclass_8h.html#aff7431c1e83d4cf5f4810ed8e9dc2e7e" title="This is a useless enum.">_blah</a>; }
</pre></div></p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4e5ef452fe3f664199e8c5e91754e0e2"></a><!-- doxytag: member="Foo::_blah" ref="a4e5ef452fe3f664199e8c5e91754e0e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classFoo.html#a4e5ef452fe3f664199e8c5e91754e0e2">Foo::_blah</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is a measure of our blahness. </p>
<p>Definition at line <a class="el" href="aclass_8h_source.html#l00048">48</a> of file <a class="el" href="aclass_8h_source.html">aclass.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="aclass_8h_source.html">aclass.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Feb 27 15:34:03 2010 for Test project by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink