Skip to content

Commit 7b745a9

Browse files
4B796C65@gmail.com4B796C65@gmail.com
authored andcommitted
Many more doc changes.
1 parent 38ebe31 commit 7b745a9

31 files changed

+2226
-1576
lines changed

CHANGELOG.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
1.1
3+
* KeyEvent.keyname is now KeyEvent.key
4+
* MouseButtonEvent.button now behaves like KeyEvent.keyname does
5+
* event.App class added
6+
* drawing methods no longer have a default for the character parameter
7+
* KeyEvent.ctrl is now KeyEvent.control

documentation/api-objects.txt

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ tdl tdl-module.html
22
tdl.setTitle tdl-module.html#setTitle
33
tdl._formatChar tdl-module.html#_formatChar
44
tdl._setfore tdl-module.html#_setfore
5+
tdl._USE_FILL tdl-module.html#_USE_FILL
56
tdl._var tdl-module.html#_var
67
tdl.flush tdl-module.html#flush
78
tdl._setback tdl-module.html#_setback
@@ -26,39 +27,45 @@ tdl._rootconsole tdl-module.html#_rootconsole
2627
tdl._setchar tdl-module.html#_setchar
2728
tdl.setFont tdl-module.html#setFont
2829
tdl.event tdl.event-module.html
30+
tdl.event._keyNames tdl.event-module.html#_keyNames
2931
tdl.event._mousem tdl.event-module.html#_mousem
3032
tdl.event._mousel tdl.event-module.html#_mousel
3133
tdl.event.keyWait tdl.event-module.html#keyWait
3234
tdl.event._var tdl.event-module.html#_var
3335
tdl.event._mouser tdl.event-module.html#_mouser
34-
tdl.event._keynames tdl.event-module.html#_keynames
35-
tdl.event._parse_keynames tdl.event-module.html#_parse_keynames
3636
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._pushedEvents tdl.event-module.html#_pushedEvents
4041
tdl.event._eventQueue tdl.event-module.html#_eventQueue
42+
tdl.event._mouseNames tdl.event-module.html#_mouseNames
43+
tdl.event._parseKeyNames tdl.event-module.html#_parseKeyNames
4144
tdl.event._processEvents tdl.event-module.html#_processEvents
45+
tdl.event.push tdl.event-module.html#push
4246
tdl.Console tdl.Console-class.html
4347
tdl.Console._setChar tdl.Console-class.html#_setChar
48+
tdl.Console._setCharCall tdl.Console-class.html#_setCharCall
4449
tdl._MetaConsole.height tdl._MetaConsole-class.html#height
45-
tdl._MetaConsole.getSize tdl._MetaConsole-class.html#getSize
50+
tdl._MetaConsole.drawStr tdl._MetaConsole-class.html#drawStr
4651
tdl._MetaConsole.drawRect tdl._MetaConsole-class.html#drawRect
4752
tdl._MetaConsole.width tdl._MetaConsole-class.html#width
4853
tdl._MetaConsole.blit tdl._MetaConsole-class.html#blit
54+
tdl.Console._initArrays tdl.Console-class.html#_initArrays
4955
tdl.Console.__init__ tdl.Console-class.html#__init__
5056
tdl.Console._newConsole tdl.Console-class.html#_newConsole
5157
tdl._MetaConsole.__contains__ tdl._MetaConsole-class.html#__contains__
5258
tdl._MetaConsole.drawChar tdl._MetaConsole-class.html#drawChar
5359
tdl.Console.__del__ tdl.Console-class.html#__del__
5460
tdl._MetaConsole._drawable tdl._MetaConsole-class.html#_drawable
61+
tdl.Console._setCharFill tdl.Console-class.html#_setCharFill
5562
tdl.Console._translate tdl.Console-class.html#_translate
5663
tdl._MetaConsole._normalizeRect tdl._MetaConsole-class.html#_normalizeRect
5764
tdl._MetaConsole._clampRect tdl._MetaConsole-class.html#_clampRect
5865
tdl.Console._replace tdl.Console-class.html#_replace
5966
tdl.Console._as_parameter_ tdl.Console-class.html#_as_parameter_
6067
tdl._MetaConsole._rectInBounds tdl._MetaConsole-class.html#_rectInBounds
61-
tdl._MetaConsole.drawStr tdl._MetaConsole-class.html#drawStr
68+
tdl._MetaConsole.getSize tdl._MetaConsole-class.html#getSize
6269
tdl.Console.clear tdl.Console-class.html#clear
6370
tdl.Console.__repr__ tdl.Console-class.html#__repr__
6471
tdl._MetaConsole.drawFrame tdl._MetaConsole-class.html#drawFrame
@@ -131,7 +138,6 @@ tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
131138
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
132139
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
133140
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
134-
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
135141
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
136142
tdl.event.KeyEvent tdl.event.KeyEvent-class.html
137143
tdl.event.KeyEvent.control tdl.event.KeyEvent-class.html#control
@@ -145,7 +151,6 @@ tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
145151
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
146152
tdl.event.KeyEvent.rightCtrl tdl.event.KeyEvent-class.html#rightCtrl
147153
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
148-
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
149154
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
150155
tdl.event.KeyUp tdl.event.KeyUp-class.html
151156
tdl.event.KeyEvent.control tdl.event.KeyEvent-class.html#control
@@ -159,7 +164,6 @@ tdl.event.KeyEvent.key tdl.event.KeyEvent-class.html#key
159164
tdl.event.KeyEvent.leftCtrl tdl.event.KeyEvent-class.html#leftCtrl
160165
tdl.event.KeyEvent.char tdl.event.KeyEvent-class.html#char
161166
tdl.event.KeyEvent.shift tdl.event.KeyEvent-class.html#shift
162-
tdl.event.KeyEvent.keyname tdl.event.KeyEvent-class.html#keyname
163167
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
164168
tdl.event.MouseButtonEvent tdl.event.MouseButtonEvent-class.html
165169
tdl.event.MouseButtonEvent.button tdl.event.MouseButtonEvent-class.html#button

documentation/class-tree.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
6262
<em class="summary">The most base type</em>
6363
<ul>
6464
<li> <strong class="uidlink"><a href="tdl.event.App-class.html">tdl.event.App</a></strong>:
65-
<em class="summary">ev_*: Events are passed to methods based on their <a
66-
href="tdl.event.Event-class.html#type" class="link">Event.type</a>
67-
attribute.</em>
65+
<em class="summary">Application framework.</em>
6866
</li>
6967
<li> <strong class="uidlink">exceptions.BaseException</strong>:
7068
<em class="summary">Common base class for all exceptions</em>
@@ -84,33 +82,35 @@ <h1 class="epydoc">Class Hierarchy</h1>
8482
<li> <strong class="uidlink"><a href="tdl.event.KeyEvent-class.html">tdl.event.KeyEvent</a></strong>
8583
<ul>
8684
<li> <strong class="uidlink"><a href="tdl.event.KeyDown-class.html">tdl.event.KeyDown</a></strong>:
87-
<em class="summary">For when the user presses a key on the keyboard or a key repeats.</em>
85+
<em class="summary">Fired when the user presses a key on the keyboard or a key repeats.</em>
8886
</li>
8987
<li> <strong class="uidlink"><a href="tdl.event.KeyUp-class.html">tdl.event.KeyUp</a></strong>:
90-
<em class="summary">For when the user releases a key on the keyboard.</em>
88+
<em class="summary">Fired when the user releases a key on the keyboard.</em>
9189
</li>
9290
</ul>
9391
</li>
9492
<li> <strong class="uidlink"><a href="tdl.event.MouseButtonEvent-class.html">tdl.event.MouseButtonEvent</a></strong>
9593
<ul>
9694
<li> <strong class="uidlink"><a href="tdl.event.MouseDown-class.html">tdl.event.MouseDown</a></strong>:
97-
<em class="summary">For when a button is pressed.</em>
95+
<em class="summary">Fired when a mouse button is pressed.</em>
9896
</li>
9997
<li> <strong class="uidlink"><a href="tdl.event.MouseUp-class.html">tdl.event.MouseUp</a></strong>:
100-
<em class="summary">For when a button is released.</em>
98+
<em class="summary">Fired when a mouse button is released.</em>
10199
</li>
102100
</ul>
103101
</li>
104102
<li> <strong class="uidlink"><a href="tdl.event.MouseMotion-class.html">tdl.event.MouseMotion</a></strong>:
105-
<em class="summary">For when the mouse is moved.</em>
103+
<em class="summary">Fired when the mouse is moved.</em>
106104
</li>
107105
<li> <strong class="uidlink"><a href="tdl.event.Quit-class.html">tdl.event.Quit</a></strong>:
108-
<em class="summary">For when the window is closed by the user.</em>
106+
<em class="summary">Fired when the window is closed by the user.</em>
109107
</li>
110108
</ul>
111109
</li>
112110
<li> <strong class="uidlink"><a href="tdl._MetaConsole-class.html">tdl._MetaConsole</a></strong>:
113-
<em class="summary">Contains methods shared by both the Console and Window classes.</em>
111+
<em class="summary">Contains methods shared by both the <a
112+
href="tdl.Console-class.html" class="link">Console</a> and <a
113+
href="tdl.Window-class.html" class="link">Window</a> classes.</em>
114114
<ul>
115115
<li> <strong class="uidlink"><a href="tdl.Console-class.html">tdl.Console</a></strong>:
116116
<em class="summary">The Console is the main class of the tdl library.</em>
@@ -155,7 +155,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
155155
<tr>
156156
<td align="left" class="footer">
157157
<a href="epydoc-log.html">Generated by Epydoc
158-
3.0.1 on Sun Sep 30 17:28:54 2012</a>
158+
3.0.1 on Thu Oct 04 00:52:15 2012</a>
159159
</td>
160160
<td align="right" class="footer">
161161
<a target="mainFrame" href="http://epydoc.sourceforge.net"

documentation/epydoc-log.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +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 Sun Sep 30 17:28:54 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 Thu Oct 04 00:52:15 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>:
15-
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>
15+
Error during parsing: invalid syntax (C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py, line 33) -- 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:
1717
No documentation available!</h2></div><div class="log-block"><h2 class="log-hdr">Epydoc Options</h2><div class="log-info">
1818
<table border="0" cellpadding="0" cellspacing="0">
1919
<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>'included'</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>
2020
</div>
21-
</div><p class="log">Epydoc finished at Sun Sep 30 17:28:55 2012</p>
21+
</div><p class="log">Epydoc finished at Thu Oct 04 00:52:16 2012</p>
2222
<p class="log">(Elapsed time: 1 seconds)</p></body>
2323
</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 Sun Sep 30 17:28:55 2012</a>
258+
3.0.1 on Thu Oct 04 00:52:15 2012</a>
259259
</td>
260260
<td align="right" class="footer">
261261
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)