Project

General

Profile

Revision 862

Added by Kevin Woo over 15 years ago

Updated analog.c and analog.h documentation and regenerated the docs. No need to remake the library as its just comments.

View differences:

ring__buffer_8h.html
4 4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.5.3 -->
8
<div class="tabs">
9
  <ul>
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li class="current"><a href="files.html"><span>Files</span></a></li>
14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15
  </ul>
7
<!-- Generated by Doxygen 1.5.5 -->
8
<div class="navigation" id="top">
9
  <div class="tabs">
10
    <ul>
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13
      <li><a href="modules.html"><span>Modules</span></a></li>
14
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16
    </ul>
17
  </div>
16 18
</div>
19
<div class="contents">
17 20
<h1>ring_buffer.h File Reference</h1>Ring Buffer. <a href="#_details">More...</a>
18 21
<p>
19 22

  
......
52 55
Copyright (c) 2007 Colony Project<p>
53 56
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>
54 57
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
55
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>
56
Include macros to create a ring buffer. Originally written for 15-410. Modified for use in ATMega128 serial driver<p>
58
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Include macros to create a ring buffer. Originally written for 15-410. Modified for use in ATMega128 serial driver<p>
57 59
<dl class="author" compact><dt><b>Author:</b></dt><dd>Cornell Wright (cgwright) <p>
58 60
Jason P. Winters (jpwinter) </dd></dl>
59 61
<hr><h2>Define Documentation</h2>
......
90 92
  </table>
91 93
</dl>
92 94

  
95
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00182">i2c_request()</a>, and <a class="el" href="i2c_8c-source.html#l00141">i2c_send()</a>.</p>
96

  
93 97
</div>
94 98
</div><p>
95 99
<a class="anchor" name="0ae5ca959a3b05583623551cc287a534"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_CLEAR" ref="0ae5ca959a3b05583623551cc287a534" args="(buf)" -->
......
121 125
  </table>
122 126
</dl>
123 127

  
128
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00107">i2c_init()</a>, and <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>
129

  
124 130
</div>
125 131
</div><p>
126 132
<a class="anchor" name="19daf3026b69a26bb3d383b14ae90e23"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_EMPTY" ref="19daf3026b69a26bb3d383b14ae90e23" args="(buf)" -->
......
148 154
  </table>
149 155
</dl>
150 156

  
157
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>
158

  
151 159
</div>
152 160
</div><p>
153 161
<a class="anchor" name="2ed153688dc60c5503f2f7fdd2b73a4a"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_FULL" ref="2ed153688dc60c5503f2f7fdd2b73a4a" args="(buf)" -->
......
175 183
  </table>
176 184
</dl>
177 185

  
186
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00182">i2c_request()</a>, and <a class="el" href="i2c_8c-source.html#l00141">i2c_send()</a>.</p>
187

  
178 188
</div>
179 189
</div><p>
180 190
<a class="anchor" name="3c186ab6ff12fa96c18f6d064720cc2c"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_INIT" ref="3c186ab6ff12fa96c18f6d064720cc2c" args="(buf, size)" -->
......
288 298
  </table>
289 299
</dl>
290 300

  
301
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>
302

  
291 303
</div>
292 304
</div><p>
293 305
<a class="anchor" name="4a0f9de5ac14f60d678cda392921a629"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_REMOVE" ref="4a0f9de5ac14f60d678cda392921a629" args="(buf, val_ret)" -->
......
323 335
  </table>
324 336
</dl>
325 337

  
338
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>
339

  
326 340
</div>
327 341
</div><p>
328
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;
342
</div>
343
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by&nbsp;
329 344
<a href="http://www.doxygen.org/index.html">
330
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
345
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
331 346
</body>
332 347
</html>

Also available in: Unified diff