Skip to content

Commit

Permalink
Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanpc committed Nov 23, 2012
1 parent 3bd49b0 commit afce41c
Show file tree
Hide file tree
Showing 25 changed files with 231 additions and 70 deletions.
4 changes: 2 additions & 2 deletions docs/html/_r_e_a_d_m_e_8md.html
Expand Up @@ -68,7 +68,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -86,7 +86,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 19 2012 13:05:34 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Nov 22 2012 19:40:53 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/bonsai_8c.html
Expand Up @@ -68,7 +68,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand Down Expand Up @@ -166,7 +166,7 @@ <h2 class="groupheader">Variable Documentation</h2>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 19 2012 13:05:34 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Nov 22 2012 19:40:53 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
Expand Down
14 changes: 8 additions & 6 deletions docs/html/files.html
Expand Up @@ -69,7 +69,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -86,16 +86,18 @@
<div class="textblock">Here is a list of all files with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="bonsai_8c.html" target="_self">bonsai.c</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="misc_8c.html" target="_self">misc.c</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a href="misc_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="misc_8h.html" target="_self">misc.h</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="process_8c.html" target="_self">process.c</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a href="process_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="process_8h.html" target="_self">process.h</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="mime_8c.html" target="_self">mime.c</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a href="mime_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="mime_8h.html" target="_self">mime.h</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="misc_8c.html" target="_self">misc.c</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a href="misc_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="misc_8h.html" target="_self">misc.h</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="process_8c.html" target="_self">process.c</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a href="process_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="process_8h.html" target="_self">process.h</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 19 2012 13:05:34 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Nov 22 2012 19:40:53 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
Expand Down
27 changes: 22 additions & 5 deletions docs/html/globals.html
Expand Up @@ -68,6 +68,7 @@
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></li>
</ul>
</div>
</div><!-- top -->
Expand All @@ -76,7 +77,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -87,23 +88,33 @@

<div class="contents">
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div><ul>
<li>get_mime()
: <a class="el" href="mime_8c.html#a0d7f4d238324d008038639d4a993174c">mime.c</a>
, <a class="el" href="mime_8h.html#a0d7f4d238324d008038639d4a993174c">mime.h</a>
</li>
<li>HEADER_SIZE
: <a class="el" href="process_8c.html#a49999be01380f41cc0d0f1f1406fb277">process.c</a>
</li>
<li>main()
: <a class="el" href="bonsai_8c.html#a0ddf1224851353fc92bfbff6f499fa97">bonsai.c</a>
</li>
<li>MAX_CONNECTIONS
: <a class="el" href="bonsai_8c.html#afbec5bc0e230dafdca37e3c2eab11982">bonsai.c</a>
</li>
<li>MAX_HEADERS
: <a class="el" href="process_8c.html#ab8949645fa8d90e1722d233c6bdfc815">process.c</a>
</li>
<li>output
: <a class="el" href="process_8c.html#a455dd59b5f3b9ec4b97c23d3797e5c94">process.c</a>
</li>
<li>parse_request_headers()
: <a class="el" href="process_8c.html#a11d5f846bbce945bb9e16217562b7ae1">process.c</a>
: <a class="el" href="process_8c.html#a558849ee895bb109213ead0c4b4913fa">process.c</a>
</li>
<li>PORT
: <a class="el" href="bonsai_8c.html#a78dc8eaa9905715367e9beb76bf4b5f7">bonsai.c</a>
</li>
<li>print_request_headers()
: <a class="el" href="process_8c.html#a867b52a63f0badb64771b4406801849e">process.c</a>
: <a class="el" href="process_8c.html#a14306b901ebaa2b9b83f7b0e43fd6bb7">process.c</a>
</li>
<li>process_request()
: <a class="el" href="process_8c.html#a2de6a564e073d4c4d7d50d37814765e4">process.c</a>
Expand All @@ -113,14 +124,20 @@
: <a class="el" href="misc_8c.html#a13492161f13dec20e31a2bab7f5a5f08">misc.c</a>
, <a class="el" href="misc_8h.html#a13492161f13dec20e31a2bab7f5a5f08">misc.h</a>
</li>
<li>request_type_and_file()
: <a class="el" href="process_8c.html#a77ab76838caf713b3a306062589a5fff">process.c</a>
</li>
<li>send_file()
: <a class="el" href="process_8c.html#a9b2a5a3d5b5b94d03e6165fdff90ed43">process.c</a>
</li>
<li>send_headers()
: <a class="el" href="process_8c.html#aa39a7e6bef8074f6b3a74d07aad0c167">process.c</a>
: <a class="el" href="process_8c.html#ad856c01448ccc88465a4468569243252">process.c</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 19 2012 13:05:34 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Nov 22 2012 19:40:53 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
Expand Down
21 changes: 16 additions & 5 deletions docs/html/globals_func.html
Expand Up @@ -68,6 +68,7 @@
<li><a href="globals.html"><span>All</span></a></li>
<li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Macros</span></a></li>
</ul>
</div>
</div><!-- top -->
Expand All @@ -76,7 +77,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -87,14 +88,18 @@

<div class="contents">
&#160;<ul>
<li>get_mime()
: <a class="el" href="mime_8c.html#a0d7f4d238324d008038639d4a993174c">mime.c</a>
, <a class="el" href="mime_8h.html#a0d7f4d238324d008038639d4a993174c">mime.h</a>
</li>
<li>main()
: <a class="el" href="bonsai_8c.html#a0ddf1224851353fc92bfbff6f499fa97">bonsai.c</a>
</li>
<li>parse_request_headers()
: <a class="el" href="process_8c.html#a11d5f846bbce945bb9e16217562b7ae1">process.c</a>
: <a class="el" href="process_8c.html#a558849ee895bb109213ead0c4b4913fa">process.c</a>
</li>
<li>print_request_headers()
: <a class="el" href="process_8c.html#a867b52a63f0badb64771b4406801849e">process.c</a>
: <a class="el" href="process_8c.html#a14306b901ebaa2b9b83f7b0e43fd6bb7">process.c</a>
</li>
<li>process_request()
: <a class="el" href="process_8c.html#a2de6a564e073d4c4d7d50d37814765e4">process.c</a>
Expand All @@ -104,14 +109,20 @@
: <a class="el" href="misc_8c.html#a13492161f13dec20e31a2bab7f5a5f08">misc.c</a>
, <a class="el" href="misc_8h.html#a13492161f13dec20e31a2bab7f5a5f08">misc.h</a>
</li>
<li>request_type_and_file()
: <a class="el" href="process_8c.html#a77ab76838caf713b3a306062589a5fff">process.c</a>
</li>
<li>send_file()
: <a class="el" href="process_8c.html#a9b2a5a3d5b5b94d03e6165fdff90ed43">process.c</a>
</li>
<li>send_headers()
: <a class="el" href="process_8c.html#aa39a7e6bef8074f6b3a74d07aad0c167">process.c</a>
: <a class="el" href="process_8c.html#ad856c01448ccc88465a4468569243252">process.c</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 19 2012 13:05:34 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Nov 22 2012 19:40:53 for bonsai by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
Expand Down

0 comments on commit afce41c

Please sign in to comment.