Skip to content

Commit ac1e247

Browse files
author
yorickvanpelt
committed
- Document(r235)
1 parent b63dc3e commit ac1e247

File tree

116 files changed

+17831
-2886
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+17831
-2886
lines changed

Diff for: web/api/api-objects.txt

+292-267
Large diffs are not rendered by default.

Diff for: web/api/class-tree.html

+48-7
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,18 @@ <h1 class="epydoc">Class Hierarchy</h1>
8282
<ul>
8383
<li> <strong class="uidlink">BaseHTTPServer.HTTPServer</strong>
8484
<ul>
85-
<li> <strong class="uidlink"><a href="webserver.myHTTPServer-class.html">webserver.myHTTPServer</a></strong>
85+
<li> <strong class="uidlink"><a href="webserver.myWebServer-class.html">webserver.myWebServer</a></strong>:
86+
<em class="summary">multithreaded webserver class for openttd-python</em>
8687
</li>
8788
</ul>
8889
</li>
8990
</ul>
9091
</li>
9192
</ul>
9293
</li>
93-
<li> <strong class="uidlink"><a href="ottd_lib.DataPacket-class.html">ottd_lib.DataPacket</a></strong>
94+
<li> <strong class="uidlink"><a href="openttd.savegame.CDataPacket-class.html">openttd.savegame.CDataPacket</a></strong>
9495
</li>
95-
<li> <strong class="uidlink"><a href="ottd_lib.DataStorageClass-class.html">ottd_lib.DataStorageClass</a></strong>
96+
<li> <strong class="uidlink"><a href="openttd.client.DataPacket-class.html">openttd.client.DataPacket</a></strong>
9697
</li>
9798
<li> <strong class="uidlink"><a href="ottd_client_event.Event-class.html">ottd_client_event.Event</a></strong>:
9899
<em class="summary">Base event class</em>
@@ -153,7 +154,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
153154
</li>
154155
</ul>
155156
</li>
156-
<li> <strong class="uidlink"><a href="ottd_grfs.GrfDB-class.html">ottd_grfs.GrfDB</a></strong>:
157+
<li> <strong class="uidlink"><a href="openttd.grfdb.GrfDB-class.html">openttd.grfdb.GrfDB</a></strong>:
157158
<em class="summary">The GRF Database used for looking up names</em>
158159
</li>
159160
<li> <strong class="uidlink">rfc822.Message</strong>:
@@ -165,9 +166,49 @@ <h1 class="epydoc">Class Hierarchy</h1>
165166
</li>
166167
</ul>
167168
</li>
169+
<li> <strong class="uidlink"><a href="openttd.savegame.OTTDSaveGameParser-class.html">openttd.savegame.OTTDSaveGameParser</a></strong>:
170+
<em class="summary">openttd-python class to parse openttd savegames</em>
171+
</li>
172+
<li> <strong class="uidlink">SocketServer.ThreadingMixIn</strong>:
173+
<em class="summary">Mix-in class to handle each request in a new thread.</em>
174+
<ul>
175+
<li> <strong class="uidlink"><a href="webserver.myWebServer-class.html">webserver.myWebServer</a></strong>:
176+
<em class="summary">multithreaded webserver class for openttd-python</em>
177+
</li>
178+
</ul>
179+
</li>
168180
<li> <strong class="uidlink">object</strong>:
169181
<em class="summary">The most base type</em>
170182
<ul>
183+
<li> <strong class="uidlink">exceptions.BaseException</strong>:
184+
<em class="summary">Common base class for all exceptions</em>
185+
<ul>
186+
<li> <strong class="uidlink">exceptions.Exception</strong>:
187+
<em class="summary">Common base class for all non-exit exceptions.</em>
188+
<ul>
189+
<li> <strong class="uidlink"><a href="openttd.savegame.LoadException-class.html">openttd.savegame.LoadException</a></strong>:
190+
<em class="summary">The exception raised by OTTDSaveGameParser when something goes
191+
wrong</em>
192+
</li>
193+
<li> <strong class="uidlink"><a href="sstruct.error-class.html">sstruct.error</a></strong>
194+
</li>
195+
</ul>
196+
</li>
197+
</ul>
198+
</li>
199+
<li> <strong class="uidlink"><a href="openttd.datastorageclass.DataStorageClass-class.html">openttd.datastorageclass.DataStorageClass</a></strong>
200+
</li>
201+
<li> <strong class="uidlink">json.encoder.JSONEncoder</strong>:
202+
<em class="summary">Extensible JSON &lt;http://json.org&gt; encoder for Python data
203+
structures.</em>
204+
<ul>
205+
<li> <strong class="uidlink"><a href="webserver.DataStorageJSONEncoder-class.html">webserver.DataStorageJSONEncoder</a></strong>
206+
</li>
207+
</ul>
208+
</li>
209+
<li> <strong class="uidlink"><a href="openttd.date.OpenTTDDate-class.html">openttd.date.OpenTTDDate</a></strong>:
210+
<em class="summary">Class that allows conversion between openttd dates and python dates</em>
211+
</li>
171212
<li> <strong class="uidlink"><a href="plugins.pluginclass.Plugin-class.html">plugins.pluginclass.Plugin</a></strong>:
172213
<em class="summary">The Plugin class, all plugins should be subclassed from this.</em>
173214
<ul>
@@ -184,10 +225,10 @@ <h1 class="epydoc">Class Hierarchy</h1>
184225
<ul>
185226
<li> <strong class="uidlink">threading.Thread</strong>
186227
<ul>
187-
<li> <strong class="uidlink"><a href="ottd_lib.Client-class.html">ottd_lib.Client</a></strong>
228+
<li> <strong class="uidlink"><a href="openttd.client.Client-class.html">openttd.client.Client</a></strong>
188229
</li>
189230
<li> <strong class="uidlink"><a href="webserver.myWebServer-class.html">webserver.myWebServer</a></strong>:
190-
<em class="summary">webserver that display the currently connected clients</em>
231+
<em class="summary">multithreaded webserver class for openttd-python</em>
191232
</li>
192233
</ul>
193234
</li>
@@ -224,7 +265,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
224265
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
225266
<tr>
226267
<td align="left" class="footer">
227-
Generated by Epydoc 3.0.1 on Sun Aug 31 16:22:21 2008
268+
Generated by Epydoc 3.0.1 on Sun Oct 19 16:13:33 2008
228269
</td>
229270
<td align="right" class="footer">
230271
<a target="mainFrame" href="http://epydoc.sourceforge.net"

Diff for: web/api/help.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ <h2> The Navigation Bar </h2>
250250
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
251251
<tr>
252252
<td align="left" class="footer">
253-
Generated by Epydoc 3.0.1 on Sun Aug 31 16:22:21 2008
253+
Generated by Epydoc 3.0.1 on Sun Oct 19 16:13:33 2008
254254
</td>
255255
<td align="right" class="footer">
256256
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)