mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
Added Doxygen doc files and config
This commit is contained in:
Mike
148
docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html
Normal file
148
docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html
Normal file
@@ -0,0 +1,148 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.16"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>pyShelf Open Source Ebook Server: app.lib.pyShelf.BookServer Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">pyShelf Open Source Ebook Server
|
||||
 <span id="projectnumber">0.1.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Open source, console based E-book server</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.16 -->
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
$(function() {
|
||||
initMenu('',false,false,'search.php','Search');
|
||||
});
|
||||
/* @license-end */</script>
|
||||
<div id="main-nav"></div>
|
||||
<div id="nav-path" class="navpath">
|
||||
<ul>
|
||||
<li class="navelem"><b>app</b></li><li class="navelem"><b>lib</b></li><li class="navelem"><b>pyShelf</b></li><li class="navelem"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html">BookServer</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-attribs">Public Attributes</a> |
|
||||
<a href="classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">app.lib.pyShelf.BookServer Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ab9842f8c0937e6e23fa9562ff4c9d9b6"><td class="memItemLeft" align="right" valign="top"><a id="ab9842f8c0937e6e23fa9562ff4c9d9b6"></a>
|
||||
def </td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</td></tr>
|
||||
<tr class="separator:ab9842f8c0937e6e23fa9562ff4c9d9b6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afdf0fe4499eb1e4d462fa24d6f542b90"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#afdf0fe4499eb1e4d462fa24d6f542b90">close_prompt</a> (self)</td></tr>
|
||||
<tr class="separator:afdf0fe4499eb1e4d462fa24d6f542b90"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6a62aedc980975e37cd10eb6006b18a3"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#a6a62aedc980975e37cd10eb6006b18a3">run</a> (self)</td></tr>
|
||||
<tr class="separator:a6a62aedc980975e37cd10eb6006b18a3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4b038dcd5db1d7ec8b7c66b9a71e09bc"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classapp_1_1lib_1_1pyShelf_1_1BookServer.html#a4b038dcd5db1d7ec8b7c66b9a71e09bc">close</a> (self)</td></tr>
|
||||
<tr class="separator:a4b038dcd5db1d7ec8b7c66b9a71e09bc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||||
Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:a2f9d0ae20161d4ef5e49bdbb95ca813e"><td class="memItemLeft" align="right" valign="top"><a id="a2f9d0ae20161d4ef5e49bdbb95ca813e"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>server_address</b></td></tr>
|
||||
<tr class="separator:a2f9d0ae20161d4ef5e49bdbb95ca813e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4281a91a7626aff5f51976bba36d867f"><td class="memItemLeft" align="right" valign="top"><a id="a4281a91a7626aff5f51976bba36d867f"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>handler</b></td></tr>
|
||||
<tr class="separator:a4281a91a7626aff5f51976bba36d867f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1bd70f6445acfc4433fb41056d0475e6"><td class="memItemLeft" align="right" valign="top"><a id="a1bd70f6445acfc4433fb41056d0475e6"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>httpd</b></td></tr>
|
||||
<tr class="separator:a1bd70f6445acfc4433fb41056d0475e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><pre class="fragment">HTTP server functions required to display e-books
|
||||
</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a4b038dcd5db1d7ec8b7c66b9a71e09bc"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a4b038dcd5db1d7ec8b7c66b9a71e09bc">◆ </a></span>close()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">def app.lib.pyShelf.BookServer.close </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname"><em>self</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<pre class="fragment">Stop HTTP Server</pre>
|
||||
</div>
|
||||
</div>
|
||||
<a id="afdf0fe4499eb1e4d462fa24d6f542b90"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#afdf0fe4499eb1e4d462fa24d6f542b90">◆ </a></span>close_prompt()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">def app.lib.pyShelf.BookServer.close_prompt </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname"><em>self</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<pre class="fragment">Prompt to close server</pre>
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6a62aedc980975e37cd10eb6006b18a3"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6a62aedc980975e37cd10eb6006b18a3">◆ </a></span>run()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">def app.lib.pyShelf.BookServer.run </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname"><em>self</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<pre class="fragment">Start HTTP Server</pre>
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li>app/lib/<a class="el" href="">pyShelf.py</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.16
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user