added doxygen generatet documentation

author: Erwin Nindl <nine@wirdorange.org> 2007-10-07 22:07:03 +0000
committer: Erwin Nindl <nine@wirdorange.org> 2007-10-07 22:07:03 +0000
commit: 7763f07327f3abce839a690df46ced3bfd1d3d09 (patch)
tree: c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classMutex.html
parent: added doxygen, and doxygen makefile target (diff)
1 files changed, 219 insertions, 0 deletions
diff --git a/doc/html/classMutex.html b/doc/html/classMutex.html
new file mode 100644
index 0000000..484c40d
--- /dev/null
+++ b/doc/html/classMutex.html
@@ -0,0 +1,219 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>anytun: Mutex Class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.1 -->
+<div class="tabs">
+  <ul>
+    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+    <li id="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="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+  </ul></div>
+<h1>Mutex Class Reference</h1><!-- doxytag: class="Mutex" --><code>#include &lt;<a class="el" href="threadUtils_8hpp-source.html">threadUtils.hpp</a>&gt;</code>
+<p>
+<a href="classMutex-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#593423d868daf926c7b0d63a833ae29a">Mutex</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#c9e9182407f5f74892318607888e9be4">~Mutex</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#7f1ad3a125c7a02b2ca338240bd1d978">Mutex</a> (const <a class="el" href="classMutex.html">Mutex</a> &amp;src)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#030a11400d00ef97813c6b232a5e3f43">operator=</a> (const <a class="el" href="classMutex.html">Mutex</a> &amp;src)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#d91be808bf0a60a16f10b897ec246d3a">lock</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#546a5b797ba29959357586aa2b3740a8">unlock</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">pthread_mutex_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#8feb0b01916c1feedd1f0c0dcd74081b">mutex</a></td></tr>
+
+<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#5bf7608e05250fb524a1229bcf83ece3">Lock</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMutex.html#0705c7682858f6dcf7fe85cba92f0a5c">Condition</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="593423d868daf926c7b0d63a833ae29a"></a><!-- doxytag: member="Mutex::Mutex" ref="593423d868daf926c7b0d63a833ae29a" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Mutex::Mutex           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="c9e9182407f5f74892318607888e9be4"></a><!-- doxytag: member="Mutex::~Mutex" ref="c9e9182407f5f74892318607888e9be4" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Mutex::~Mutex           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="7f1ad3a125c7a02b2ca338240bd1d978"></a><!-- doxytag: member="Mutex::Mutex" ref="7f1ad3a125c7a02b2ca338240bd1d978" args="(const Mutex &amp;src)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Mutex::Mutex           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classMutex.html">Mutex</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>src</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="030a11400d00ef97813c6b232a5e3f43"></a><!-- doxytag: member="Mutex::operator=" ref="030a11400d00ef97813c6b232a5e3f43" args="(const Mutex &amp;src)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Mutex::operator=           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classMutex.html">Mutex</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>src</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="d91be808bf0a60a16f10b897ec246d3a"></a><!-- doxytag: member="Mutex::lock" ref="d91be808bf0a60a16f10b897ec246d3a" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Mutex::lock           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline, private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="546a5b797ba29959357586aa2b3740a8"></a><!-- doxytag: member="Mutex::unlock" ref="546a5b797ba29959357586aa2b3740a8" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Mutex::unlock           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline, private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Friends And Related Function Documentation</h2>
+<a class="anchor" name="5bf7608e05250fb524a1229bcf83ece3"></a><!-- doxytag: member="Mutex::Lock" ref="5bf7608e05250fb524a1229bcf83ece3" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">friend class <a class="el" href="classLock.html">Lock</a><code> [friend]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="0705c7682858f6dcf7fe85cba92f0a5c"></a><!-- doxytag: member="Mutex::Condition" ref="0705c7682858f6dcf7fe85cba92f0a5c" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">friend class <a class="el" href="classCondition.html">Condition</a><code> [friend]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Member Data Documentation</h2>
+<a class="anchor" name="8feb0b01916c1feedd1f0c0dcd74081b"></a><!-- doxytag: member="Mutex::mutex" ref="8feb0b01916c1feedd1f0c0dcd74081b" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pthread_mutex_t <a class="el" href="classMutex.html#8feb0b01916c1feedd1f0c0dcd74081b">Mutex::mutex</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="threadUtils_8hpp-source.html">threadUtils.hpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
+</body>
+</html>
author	Erwin Nindl <nine@wirdorange.org>	2007-10-07 22:07:03 +0000
committer	Erwin Nindl <nine@wirdorange.org>	2007-10-07 22:07:03 +0000
commit	7763f07327f3abce839a690df46ced3bfd1d3d09 (patch)
tree	c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classMutex.html
parent	added doxygen, and doxygen makefile target (diff)