Skip to content

Commit 2ee547e

Browse files
4B796C65@gmail.com4B796C65@gmail.com
authored andcommitted
Partial documentation updates. Better names for positional modifier keys.
1 parent e5b078f commit 2ee547e

28 files changed

+1195
-809
lines changed

documentation/api-objects.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ tdl.event.__package__ tdl.event-module.html#__package__
3737
tdl.event._lib tdl.event-module.html#_lib
3838
tdl.event.isWindowClosed tdl.event-module.html#isWindowClosed
3939
tdl.event.get tdl.event-module.html#get
40+
tdl.event._eventQueue tdl.event-module.html#_eventQueue
41+
tdl.event._processEvents tdl.event-module.html#_processEvents
4042
tdl.Console tdl.Console-class.html
4143
tdl.Console._setChar tdl.Console-class.html#_setChar
4244
tdl._MetaConsole.height tdl._MetaConsole-class.html#height
@@ -104,10 +106,12 @@ tdl._MetaConsole._rectInBounds tdl._MetaConsole-class.html#_rectInBounds
104106
tdl._MetaConsole.drawStr tdl._MetaConsole-class.html#drawStr
105107
tdl._MetaConsole.scroll tdl._MetaConsole-class.html#scroll
106108
tdl.event.App tdl.event.App-class.html
109+
tdl.event.App.suspend tdl.event.App-class.html#suspend
107110
tdl.event.App.ev_MOUSEUP tdl.event.App-class.html#ev_MOUSEUP
108111
tdl.event.App.ev_MOUSEDOWN tdl.event.App-class.html#ev_MOUSEDOWN
109112
tdl.event.App.run tdl.event.App-class.html#run
110113
tdl.event.App.update tdl.event.App-class.html#update
114+
tdl.event.App.__running tdl.event.App-class.html#__running
111115
tdl.event.App.ev_KEYUP tdl.event.App-class.html#ev_KEYUP
112116
tdl.event.App.ev_QUIT tdl.event.App-class.html#ev_QUIT
113117
tdl.event.App.ev_KEYDOWN tdl.event.App-class.html#ev_KEYDOWN
@@ -117,46 +121,46 @@ tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
117121
tdl.event.Event.type tdl.event.Event-class.html#type
118122
tdl.event.KeyDown tdl.event.KeyDown-class.html
119123
tdl.event.KeyEvent.ctrl tdl.event.KeyEvent-class.html#ctrl
120-
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
124+
tdl.event.KeyEvent.rightCtrl tdl.event.KeyEvent-class.html#rightCtrl
121125
tdl.event.KeyEvent.alt tdl.event.KeyEvent-class.html#alt
122126
tdl.event.KeyEvent.__init__ tdl.event.KeyEvent-class.html#__init__
123-
tdl.event.KeyEvent.ralt tdl.event.KeyEvent-class.html#ralt
124-
tdl.event.KeyEvent.rctrl tdl.event.KeyEvent-class.html#rctrl
125127
tdl.event.KeyDown.type tdl.event.KeyDown-class.html#type
128+
tdl.event.KeyEvent.rightAlt tdl.event.KeyEvent-class.html#rightAlt
129+
tdl.event.KeyEvent.leftAlt tdl.event.KeyEvent-class.html#leftAlt
126130
tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
131+
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
132+
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
127133
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
128134
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
129135
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
130-
tdl.event.KeyEvent.lalt tdl.event.KeyEvent-class.html#lalt
131-
tdl.event.KeyEvent.lctrl tdl.event.KeyEvent-class.html#lctrl
132136
tdl.event.KeyEvent tdl.event.KeyEvent-class.html
133137
tdl.event.KeyEvent.ctrl tdl.event.KeyEvent-class.html#ctrl
134138
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
135139
tdl.event.KeyEvent.alt tdl.event.KeyEvent-class.html#alt
136140
tdl.event.KeyEvent.__init__ tdl.event.KeyEvent-class.html#__init__
137-
tdl.event.KeyEvent.ralt tdl.event.KeyEvent-class.html#ralt
138-
tdl.event.KeyEvent.rctrl tdl.event.KeyEvent-class.html#rctrl
139141
tdl.event.Event.type tdl.event.Event-class.html#type
142+
tdl.event.KeyEvent.rightAlt tdl.event.KeyEvent-class.html#rightAlt
143+
tdl.event.KeyEvent.leftAlt tdl.event.KeyEvent-class.html#leftAlt
140144
tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
145+
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
146+
tdl.event.KeyEvent.rightCtrl tdl.event.KeyEvent-class.html#rightCtrl
141147
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
142148
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
143149
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
144-
tdl.event.KeyEvent.lalt tdl.event.KeyEvent-class.html#lalt
145-
tdl.event.KeyEvent.lctrl tdl.event.KeyEvent-class.html#lctrl
146150
tdl.event.KeyUp tdl.event.KeyUp-class.html
147151
tdl.event.KeyEvent.ctrl tdl.event.KeyEvent-class.html#ctrl
148-
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
152+
tdl.event.KeyEvent.rightCtrl tdl.event.KeyEvent-class.html#rightCtrl
149153
tdl.event.KeyEvent.alt tdl.event.KeyEvent-class.html#alt
150154
tdl.event.KeyEvent.__init__ tdl.event.KeyEvent-class.html#__init__
151-
tdl.event.KeyEvent.ralt tdl.event.KeyEvent-class.html#ralt
152-
tdl.event.KeyEvent.rctrl tdl.event.KeyEvent-class.html#rctrl
153155
tdl.event.KeyUp.type tdl.event.KeyUp-class.html#type
156+
tdl.event.KeyEvent.rightAlt tdl.event.KeyEvent-class.html#rightAlt
157+
tdl.event.KeyEvent.leftAlt tdl.event.KeyEvent-class.html#leftAlt
154158
tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
159+
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
160+
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
155161
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
156162
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
157163
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
158-
tdl.event.KeyEvent.lalt tdl.event.KeyEvent-class.html#lalt
159-
tdl.event.KeyEvent.lctrl tdl.event.KeyEvent-class.html#lctrl
160164
tdl.event.MouseButtonEvent tdl.event.MouseButtonEvent-class.html
161165
tdl.event.MouseButtonEvent.button tdl.event.MouseButtonEvent-class.html#button
162166
tdl.event.MouseButtonEvent.pos tdl.event.MouseButtonEvent-class.html#pos

documentation/class-tree.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
146146
<tr>
147147
<td align="left" class="footer">
148148
<a href="epydoc-log.html">Generated by Epydoc
149-
3.0.1 on Thu Sep 27 13:02:21 2012</a>
149+
3.0.1 on Sun Sep 30 01:30:48 2012</a>
150150
</td>
151151
<td align="right" class="footer">
152152
<a target="mainFrame" href="http://epydoc.sourceforge.net"

documentation/epydoc-log.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@
1010
<body bgcolor="white" text="black" link="blue" vlink="#204080"
1111
alink="#204080">
1212
<h1 class="epydoc">Epydoc Log</h1>
13-
<p class="log">Epydoc started at Thu Sep 27 13:02:20 2012</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py:
13+
<p class="log">Epydoc started at Sun Sep 30 01:30:48 2012</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py:
1414
Source code parsing failed (but introspection was successful).</h2><div class="log-error"><b>Error</b>:
1515
Error during parsing: invalid syntax (C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py, line 11) -- Attempted relative import in non-package, or beyond toplevel package</div>
1616
</div><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__tcod.py:
17-
No documentation available!</h2></div><div class="log-block"><h2 class="log-hdr">File C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\event.py, line 155, in tdl.event.get</h2><div class="log-warning"><b>Docstring Warning</b>:
18-
Lines 159, 160, 161, 162, 163, 164: Improper paragraph indentation.</div>
19-
</div><div class="log-block"><h2 class="log-hdr">Epydoc Options</h2><div class="log-info">
17+
No documentation available!</h2></div><div class="log-block"><h2 class="log-hdr">Epydoc Options</h2><div class="log-info">
2018
<table border="0" cellpadding="0" cellspacing="0">
2119
<tr valign="top" class="opt-changed"><td valign="top">configfiles</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['epydoc.config']</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">include_log</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">inheritance</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'grouped'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">names</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['../tdl']</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">prj_name</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'python-tdl'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">prj_url</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'http://code.google.com/p/python-tdl/'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">show_private</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">target</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'./'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">verbosity</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>1</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">action</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'html'</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">css</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">debug</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">docformat</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'epytext'</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">dotpath</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['__tcod']</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude_introspect</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude_parse</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api_file</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api_root</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">fail_on</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graph_font</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graph_font_size</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graphs</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">help_file</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">include_source_code</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">introspect</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">list_classes_separately</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">load_pickle</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">parse</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">prj_link</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">profile</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">pstat_files</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">quiet</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>0</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">redundant_details</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">show_frames</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">show_imports</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">simple_term</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">src_code_tab_width</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>8</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">top_page</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">verbose</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>0</tt></td></tr></table>
2220
</div>
23-
</div><p class="log">Epydoc finished at Thu Sep 27 13:02:22 2012</p>
21+
</div><p class="log">Epydoc finished at Sun Sep 30 01:30:49 2012</p>
2422
<p class="log">(Elapsed time: 1 seconds)</p></body>
2523
</html>

documentation/help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ <h2> The Navigation Bar </h2>
255255
<tr>
256256
<td align="left" class="footer">
257257
<a href="epydoc-log.html">Generated by Epydoc
258-
3.0.1 on Thu Sep 27 13:02:21 2012</a>
258+
3.0.1 on Sun Sep 30 01:30:48 2012</a>
259259
</td>
260260
<td align="right" class="footer">
261261
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)