Commits

Lenard Lindstrom committed 67d3601

move locals.doc and remove redundant constant descriptions. instead refer to other module pages

  • Participants
  • Parent commits add117b

Comments (0)

Files changed (5)

File docs/ref/index.html

 <li><a href="cdrom.html#pygame.cdrom.init">pygame.cdrom.init</a> - <font size=-1>initialize the cdrom module</font></li>
 <li><a href="cdrom.html#pygame.cdrom.quit">pygame.cdrom.quit</a> - <font size=-1>uninitialize the cdrom module</font></li>
 </ul>
-<li><a href="locals.html#pygame.contants">pygame.contants</a> - <font size=-1>Pygame constants</font></li>
-<ul>
-<li><a href="locals.html#display">display</a> - <font size=-1>The following constants are used by the display module and Surfaces</font></li>
-<li><a href="locals.html#events">events</a> - <font size=-1>These constants define the various event types</font></li>
-<li><a href="locals.html#keyboard">keyboard</a> - <font size=-1>These constants represent the keys on the keyboard.</font></li>
-<li><a href="locals.html#modifiers">modifiers</a> - <font size=-1>These constants represent the modifier keys on the keyboard.</font></li>
-<li><a href="locals.html#time">time</a> - <font size=-1>These constants define the various time constants</font></li>
-</ul>
 <li><a href="cursors.html#pygame.cursors">pygame.cursors</a> - <font size=-1>pygame module for cursor resources</font></li>
 <ul>
 <li><a href="cursors.html#pygame.cursors.compile">pygame.cursors.compile</a> - <font size=-1>create binary cursor data from simple strings</font></li>
 <li><a href="key.html#pygame.key.set_mods">pygame.key.set_mods</a> - <font size=-1>temporarily set which modifier keys are pressed</font></li>
 <li><a href="key.html#pygame.key.set_repeat">pygame.key.set_repeat</a> - <font size=-1>control how held keys are repeated</font></li>
 </ul>
+<li><a href="locals.html#pygame.locals">pygame.locals</a> - <font size=-1>pygame constants</font></li>
 <li><a href="mask.html#pygame.mask">pygame.mask</a> - <font size=-1>pygame module for image masks.</font></li>
 <ul>
 <li><a href="mask.html#pygame.mask.Mask">pygame.mask.Mask</a> - <font size=-1>pygame object for representing 2d bitmasks</font></li>

File docs/ref/locals.html

 <br>
 
 
-<a name="pygame.contants">
-<big><b>pygame.contants</big></b><br><ul>
-  <i>Pygame constants</i><br>
-<ul><small><table>
-  <tr><td><a href="locals.html#display">display</a> - <font size=-1>The following constants are used by the display module and Surfaces</font></td><td>The following constants are used by the display module and Surfaces</td></tr>
-  <tr><td><a href="locals.html#events">events</a> - <font size=-1>These constants define the various event types</font></td><td>These constants define the various event types</td></tr>
-  <tr><td><a href="locals.html#keyboard">keyboard</a> - <font size=-1>These constants represent the keys on the keyboard.</font></td><td>These constants represent the keys on the keyboard.</td></tr>
-  <tr><td><a href="locals.html#modifiers">modifiers</a> - <font size=-1>These constants represent the modifier keys on the keyboard.</font></td><td>These constants represent the modifier keys on the keyboard.</td></tr>
-  <tr><td><a href="locals.html#time">time</a> - <font size=-1>These constants define the various time constants</font></td><td>These constants define the various time constants</td></tr>
-</table></small></ul>
-<p>These constants are defined by <tt>SDL</tt>, and needed in pygame. Note that many of the flags for <tt>SDL</tt> are not needed in pygame, and are not included here. These constants are generally accessed from the <tt>pygame.locals</tt> module. This module is automatically placed in the pygame namespace, but you will usually want to place them directly into your module's namespace with the following command, 'from <tt>pygame.locals</tt> import *'. </p>
-<!--COMMENTS:pygame.contants--> &nbsp;<br> 
-
-
-<a name="display">
-<big><b>display</big></b><br><ul>
-  <i>The following constants are used by the display module and Surfaces</i><br>
-<pre>    HWSURFACE - surface in hardware video memory. (equal to 1)
-    RESIZABLE - display window is resizeable
-    ASYNCBLIT - surface blits happen asynchronously (threaded)
-    OPENGL - display surface will be controlled by opengl
-    HWPALETTE - display surface has animatable hardware palette entries
-    DOUBLEBUF - hardware display surface is page flippable
-    FULLSCREEN - display surface is fullscreen (nonwindowed)
-    RLEACCEL - compile for quick alpha blits, only set in alpha or colorkey funcs
-    NOFRAME - no window decorations
-</pre>
-<!--COMMENTS:display--> &nbsp;<br> 
-<br></ul>
-
-
-<a name="events">
-<big><b>events</big></b><br><ul>
-  <i>These constants define the various event types</i><br>
-<pre>    NOEVENT - no event, represents an empty event list, equal to 0
-    ACTIVEEVENT - window has gain/lost mouse/keyboard/visiblity focus
-    KEYDOWN - keyboard button has been pressed (or down and repeating)
-    KEYUP - keyboard button has been released
-    MOUSEMOTION - mouse has moved
-    MOUSEBUTTONDOWN - mouse button has been pressed
-    MOUSEBUTTONUP - mouse button has been released
-    JOYAXISMOTION - an opened joystick axis has changed
-    JOYBALLMOTION - an opened joystick ball has moved
-    JOYHATMOTION - an opened joystick hat has moved
-    JOYBUTTONDOWN - an opened joystick button has been pressed
-    JOYBUTTONUP - an opened joystick button has been released
-    VIDEORESIZE - the display window has been resized by the user
-    QUIT - the user has requested the game to quit
-    SYSWMEVENT - currently unsupported, system dependant
-    USEREVENT - all user messages are this or higher
-    NUMEVENTS - all user messages must be lower than this, equal to 32
-</pre>
-<!--COMMENTS:events--> &nbsp;<br> 
-<br></ul>
-
-
-<a name="keyboard">
-<big><b>keyboard</big></b><br><ul>
-  <i>These constants represent the keys on the keyboard.</i><br>
-<p>There are many keyboard constants, they are used to represent keys on the keyboard. The following is a list of all keyboard constants </p>
-<pre>    <b>KeyASCII</b>       <b>ASCII</b> <b>Common Name</b>
-    K_BACKSPACE    \b    <i>backspace</i>
-    K_TAB          \t    <i>tab</i>
-    K_CLEAR              <i>clear</i>
-    K_RETURN       \r    <i>return</i>
-    K_PAUSE              <i>pause</i>
-    K_ESCAPE       ^[    <i>escape</i>
-    K_SPACE              <i>space</i>
-    K_EXCLAIM      !     <i>exclaim</i>
-    K_QUOTEDBL     &quot;     <i>quotedbl</i>
-    K_HASH         #     <i>hash</i>
-    K_DOLLAR       $     <i>dollar</i>
-    K_AMPERSAND    &amp;     <i>ampersand</i>
-    K_QUOTE        '     <i>quote</i>
-    K_LEFTPAREN    (     <i>left parenthesis</i>
-    K_RIGHTPAREN   )     <i>right parenthesis</i>
-    K_ASTERISK     *     <i>asterisk</i>
-    K_PLUS         +     <i>plus sign</i>
-    K_COMMA        ,     <i>comma</i>
-    K_MINUS        -     <i>minus sign</i>
-    K_PERIOD       .     <i>period</i>
-    K_SLASH        /     <i>forward slash</i>
-    K_0            0     <i>0</i>
-    K_1            1     <i>1</i>
-    K_2            2     <i>2</i>
-    K_3            3     <i>3</i>
-    K_4            4     <i>4</i>
-    K_5            5     <i>5</i>
-    K_6            6     <i>6</i>
-    K_7            7     <i>7</i>
-    K_8            8     <i>8</i>
-    K_9            9     <i>9</i>
-    K_COLON        :     <i>colon</i>
-    K_SEMICOLON    ;     <i>semicolon</i>
-    K_LESS         &lt;     <i>less-than sign</i>
-    K_EQUALS       =     <i>equals sign</i>
-    K_GREATER      &gt;     <i>greater-than sign</i>
-    K_QUESTION     ?     <i>question mark</i>
-    K_AT           @     <i>at</i>
-    K_LEFTBRACKET  [     <i>left bracket</i>
-    K_BACKSLASH    \     <i>backslash</i>
-    K_RIGHTBRACKET ]     <i>right bracket</i>
-    K_CARET        ^     <i>caret</i>
-    K_UNDERSCORE   _     <i>underscore</i>
-    K_BACKQUOTE    `     <i>grave</i>
-    K_a            a     <i>a</i>
-    K_b            b     <i>b</i>
-    K_c            c     <i>c</i>
-    K_d            d     <i>d</i>
-    K_e            e     <i>e</i>
-    K_f            f     <i>f</i>
-    K_g            g     <i>g</i>
-    K_h            h     <i>h</i>
-    K_i            i     <i>i</i>
-    K_j            j     <i>j</i>
-    K_k            k     <i>k</i>
-    K_l            l     <i>l</i>
-    K_m            m     <i>m</i>
-    K_n            n     <i>n</i>
-    K_o            o     <i>o</i>
-    K_p            p     <i>p</i>
-    K_q            q     <i>q</i>
-    K_r            r     <i>r</i>
-    K_s            s     <i>s</i>
-    K_t            t     <i>t</i>
-    K_u            u     <i>u</i>
-    K_v            v     <i>v</i>
-    K_w            w     <i>w</i>
-    K_x            x     <i>x</i>
-    K_y            y     <i>y</i>
-    K_z            z     <i>z</i>
-    K_DELETE             <i>delete</i>
-    K_KP0                <i>keypad 0</i>
-    K_KP1                <i>keypad 1</i>
-    K_KP2                <i>keypad 2</i>
-    K_KP3                <i>keypad 3</i>
-    K_KP4                <i>keypad 4</i>
-    K_KP5                <i>keypad 5</i>
-    K_KP6                <i>keypad 6</i>
-    K_KP7                <i>keypad 7</i>
-    K_KP8                <i>keypad 8</i>
-    K_KP9                <i>keypad 9</i>
-    K_KP_PERIOD    .     <i>keypad period</i>
-    K_KP_DIVIDE    /     <i>keypad divide</i>
-    K_KP_MULTIPLY  *     <i>keypad multiply</i>
-    K_KP_MINUS     -     <i>keypad minus</i>
-    K_KP_PLUS      +     <i>keypad plus</i>
-    K_KP_ENTER     \r    <i>keypad enter</i>
-    K_KP_EQUALS    =     <i>keypad equals</i>
-    K_UP                 <i>up arrow</i>
-    K_DOWN               <i>down arrow</i>
-    K_RIGHT              <i>right arrow</i>
-    K_LEFT               <i>left arrow</i>
-    K_INSERT             <i>insert</i>
-    K_HOME               <i>home</i>
-    K_END                <i>end</i>
-    K_PAGEUP             <i>page up</i>
-    K_PAGEDOWN           <i>page down</i>
-    K_F1                 <i>F1</i>
-    K_F2                 <i>F2</i>
-    K_F3                 <i>F3</i>
-    K_F4                 <i>F4</i>
-    K_F5                 <i>F5</i>
-    K_F6                 <i>F6</i>
-    K_F7                 <i>F7</i>
-    K_F8                 <i>F8</i>
-    K_F9                 <i>F9</i>
-    K_F10                <i>F10</i>
-    K_F11                <i>F11</i>
-    K_F12                <i>F12</i>
-    K_F13                <i>F13</i>
-    K_F14                <i>F14</i>
-    K_F15                <i>F15</i>
-    K_NUMLOCK            <i>numlock</i>
-    K_CAPSLOCK           <i>capslock</i>
-    K_SCROLLOCK          <i>scrollock</i>
-    K_RSHIFT             <i>right shift</i>
-    K_LSHIFT             <i>left shift</i>
-    K_RCTRL              <i>right ctrl</i>
-    K_LCTRL              <i>left ctrl</i>
-    K_RALT               <i>right alt</i>
-    K_LALT               <i>left alt</i>
-    K_RMETA              <i>right meta</i>
-    K_LMETA              <i>left meta</i>
-    K_LSUPER             <i>left windows key</i>
-    K_RSUPER             <i>right windows key</i>
-    K_MODE               <i>mode shift</i>
-    K_HELP               <i>help</i>
-    K_PRINT              <i>print-screen</i>
-    K_SYSREQ             <i>SysRq</i>
-    K_BREAK              <i>break</i>
-    K_MENU               <i>menu</i>
-    K_POWER              <i>power</i>
-    K_EURO               <i>euro</i>
-</pre>
-<!--COMMENTS:keyboard--> &nbsp;<br> 
-<br></ul>
-
-
-<a name="modifiers">
-<big><b>modifiers</big></b><br><ul>
-  <i>These constants represent the modifier keys on the keyboard.</i><br>
-<p>Their states are treated slightly differently than normal keyboard button states, and you can temporarily set their states. </p>
-<pre>    KMOD_NONE, KMOD_LSHIFT, KMOD_RSHIFT, KMOD_SHIFT, KMOD_CAPS,
-    KMOD_LCTRL, KMOD_RCTRL, KMOD_CTRL, KMOD_LALT, KMOD_RALT,
-    KMOD_ALT, KMOD_LMETA, KMOD_RMETA, KMOD_META, KMOD_NUM, KMOD_MODE
-</pre>
-<!--COMMENTS:modifiers--> &nbsp;<br> 
-<br></ul>
-
-
-<a name="time">
-<big><b>time</big></b><br><ul>
-  <i>These constants define the various time constants</i><br>
-<pre>    TIMER_RESOLUTION - minimum timer resolution in milliseconds
-</pre>
-<!--COMMENTS:time--> &nbsp;<br> 
-<br></ul>
+<a name="pygame.locals">
+<big><b>pygame.locals</big></b><br><ul>
+  <i>pygame constants</i><br>
+<p>This module contains various constants used by Pygame. It's contents are automatically placed in the pygame module namespace. However, an application can use <tt>pygame.locals</tt> to include only the Pygame constants with a 'from <tt>pygame.locals</tt> import *'. </p>
+<p>Detailed descriptions of the various constants are found throughout the Pygame documentation. <tt>pygame.display.set_mode</tt> flags like <tt>HWSURFACE</tt> are found in the Display section. Event types are explained in the Event section. Keyboard <tt>K_</tt> constants relating to the key attribute of a <tt>KEYDOWN</tt> or <tt>KEYUP</tt> event are listed in the Key section. Also found there are the various <tt>MOD_</tt> key modifiers. Finally, <tt>TIMER_RESOLUTION</tt> is defined in Time. </p>
+<!--COMMENTS:pygame.locals--> &nbsp;<br> 
 <br></ul>
 
 </body></html>

File lib/locals.doc

+pygame.locals
+pygame constants
+
+This module contains various constants used by Pygame. It's contents are
+automatically placed in the pygame module namespace. However, an application
+can use pygame.locals to include only the Pygame constants with a
+'from pygame.locals import *'.
+
+Detailed descriptions of the various constants are found throughout the
+Pygame documentation. pygame.display.set_mode flags like HWSURFACE are found
+in the Display section. Event types are explained in the Event section.
+Keyboard K_ constants relating to the key attribute of a KEYDOWN or KEYUP
+event are listed in the Key section. Also found there are the various MOD_ key
+modifiers. Finally, TIMER_RESOLUTION is defined in Time.
+<END>

File src/locals.doc

-pygame.contants
-Pygame constants
-
-These constants are defined by SDL, and needed in pygame. Note that many of the
-flags for SDL are not needed in pygame, and are not included here. These
-constants are generally accessed from the pygame.locals module. This module is
-automatically placed in the pygame namespace, but you will usually want to
-place them directly into your module's namespace with the following command,
-'from pygame.locals import *'.
-<SECTION>
-
-
-
-"display"
-The following constants are used by the display module and Surfaces
-
-    HWSURFACE - surface in hardware video memory. (equal to 1)
-    RESIZABLE - display window is resizeable
-    ASYNCBLIT - surface blits happen asynchronously (threaded)
-    OPENGL - display surface will be controlled by opengl
-    HWPALETTE - display surface has animatable hardware palette entries
-    DOUBLEBUF - hardware display surface is page flippable
-    FULLSCREEN - display surface is fullscreen (nonwindowed)
-    RLEACCEL - compile for quick alpha blits, only set in alpha or colorkey funcs
-    NOFRAME - no window decorations
-<END>
-
-
-
-"events"
-These constants define the various event types
-
-    NOEVENT - no event, represents an empty event list, equal to 0
-    ACTIVEEVENT - window has gain/lost mouse/keyboard/visiblity focus
-    KEYDOWN - keyboard button has been pressed (or down and repeating)
-    KEYUP - keyboard button has been released
-    MOUSEMOTION - mouse has moved
-    MOUSEBUTTONDOWN - mouse button has been pressed
-    MOUSEBUTTONUP - mouse button has been released
-    JOYAXISMOTION - an opened joystick axis has changed
-    JOYBALLMOTION - an opened joystick ball has moved
-    JOYHATMOTION - an opened joystick hat has moved
-    JOYBUTTONDOWN - an opened joystick button has been pressed
-    JOYBUTTONUP - an opened joystick button has been released
-    VIDEORESIZE - the display window has been resized by the user
-    QUIT - the user has requested the game to quit
-    SYSWMEVENT - currently unsupported, system dependant
-    USEREVENT - all user messages are this or higher
-    NUMEVENTS - all user messages must be lower than this, equal to 32
-<END>
-
-
-
-"keyboard"
-These constants represent the keys on the keyboard.
-
-There are many keyboard constants, they are used to represent keys on the keyboard. The following is a list of all keyboard constants
-
-    <b>KeyASCII</b>       <b>ASCII</b> <b>Common Name</b>
-    K_BACKSPACE    \b    <i>backspace</i>
-    K_TAB          \t    <i>tab</i>
-    K_CLEAR              <i>clear</i>
-    K_RETURN       \r    <i>return</i>
-    K_PAUSE              <i>pause</i>
-    K_ESCAPE       ^[    <i>escape</i>
-    K_SPACE              <i>space</i>
-    K_EXCLAIM      !     <i>exclaim</i>
-    K_QUOTEDBL     &quot;     <i>quotedbl</i>
-    K_HASH         #     <i>hash</i>
-    K_DOLLAR       $     <i>dollar</i>
-    K_AMPERSAND    &amp;     <i>ampersand</i>
-    K_QUOTE        '     <i>quote</i>
-    K_LEFTPAREN    (     <i>left parenthesis</i>
-    K_RIGHTPAREN   )     <i>right parenthesis</i>
-    K_ASTERISK     *     <i>asterisk</i>
-    K_PLUS         +     <i>plus sign</i>
-    K_COMMA        ,     <i>comma</i>
-    K_MINUS        -     <i>minus sign</i>
-    K_PERIOD       .     <i>period</i>
-    K_SLASH        /     <i>forward slash</i>
-    K_0            0     <i>0</i>
-    K_1            1     <i>1</i>
-    K_2            2     <i>2</i>
-    K_3            3     <i>3</i>
-    K_4            4     <i>4</i>
-    K_5            5     <i>5</i>
-    K_6            6     <i>6</i>
-    K_7            7     <i>7</i>
-    K_8            8     <i>8</i>
-    K_9            9     <i>9</i>
-    K_COLON        :     <i>colon</i>
-    K_SEMICOLON    ;     <i>semicolon</i>
-    K_LESS         &lt;     <i>less-than sign</i>
-    K_EQUALS       =     <i>equals sign</i>
-    K_GREATER      &gt;     <i>greater-than sign</i>
-    K_QUESTION     ?     <i>question mark</i>
-    K_AT           @     <i>at</i>
-    K_LEFTBRACKET  [     <i>left bracket</i>
-    K_BACKSLASH    \     <i>backslash</i>
-    K_RIGHTBRACKET ]     <i>right bracket</i>
-    K_CARET        ^     <i>caret</i>
-    K_UNDERSCORE   _     <i>underscore</i>
-    K_BACKQUOTE    `     <i>grave</i>
-    K_a            a     <i>a</i>
-    K_b            b     <i>b</i>
-    K_c            c     <i>c</i>
-    K_d            d     <i>d</i>
-    K_e            e     <i>e</i>
-    K_f            f     <i>f</i>
-    K_g            g     <i>g</i>
-    K_h            h     <i>h</i>
-    K_i            i     <i>i</i>
-    K_j            j     <i>j</i>
-    K_k            k     <i>k</i>
-    K_l            l     <i>l</i>
-    K_m            m     <i>m</i>
-    K_n            n     <i>n</i>
-    K_o            o     <i>o</i>
-    K_p            p     <i>p</i>
-    K_q            q     <i>q</i>
-    K_r            r     <i>r</i>
-    K_s            s     <i>s</i>
-    K_t            t     <i>t</i>
-    K_u            u     <i>u</i>
-    K_v            v     <i>v</i>
-    K_w            w     <i>w</i>
-    K_x            x     <i>x</i>
-    K_y            y     <i>y</i>
-    K_z            z     <i>z</i>
-    K_DELETE             <i>delete</i>
-    K_KP0                <i>keypad 0</i>
-    K_KP1                <i>keypad 1</i>
-    K_KP2                <i>keypad 2</i>
-    K_KP3                <i>keypad 3</i>
-    K_KP4                <i>keypad 4</i>
-    K_KP5                <i>keypad 5</i>
-    K_KP6                <i>keypad 6</i>
-    K_KP7                <i>keypad 7</i>
-    K_KP8                <i>keypad 8</i>
-    K_KP9                <i>keypad 9</i>
-    K_KP_PERIOD    .     <i>keypad period</i>
-    K_KP_DIVIDE    /     <i>keypad divide</i>
-    K_KP_MULTIPLY  *     <i>keypad multiply</i>
-    K_KP_MINUS     -     <i>keypad minus</i>
-    K_KP_PLUS      +     <i>keypad plus</i>
-    K_KP_ENTER     \r    <i>keypad enter</i>
-    K_KP_EQUALS    =     <i>keypad equals</i>
-    K_UP                 <i>up arrow</i>
-    K_DOWN               <i>down arrow</i>
-    K_RIGHT              <i>right arrow</i>
-    K_LEFT               <i>left arrow</i>
-    K_INSERT             <i>insert</i>
-    K_HOME               <i>home</i>
-    K_END                <i>end</i>
-    K_PAGEUP             <i>page up</i>
-    K_PAGEDOWN           <i>page down</i>
-    K_F1                 <i>F1</i>
-    K_F2                 <i>F2</i>
-    K_F3                 <i>F3</i>
-    K_F4                 <i>F4</i>
-    K_F5                 <i>F5</i>
-    K_F6                 <i>F6</i>
-    K_F7                 <i>F7</i>
-    K_F8                 <i>F8</i>
-    K_F9                 <i>F9</i>
-    K_F10                <i>F10</i>
-    K_F11                <i>F11</i>
-    K_F12                <i>F12</i>
-    K_F13                <i>F13</i>
-    K_F14                <i>F14</i>
-    K_F15                <i>F15</i>
-    K_NUMLOCK            <i>numlock</i>
-    K_CAPSLOCK           <i>capslock</i>
-    K_SCROLLOCK          <i>scrollock</i>
-    K_RSHIFT             <i>right shift</i>
-    K_LSHIFT             <i>left shift</i>
-    K_RCTRL              <i>right ctrl</i>
-    K_LCTRL              <i>left ctrl</i>
-    K_RALT               <i>right alt</i>
-    K_LALT               <i>left alt</i>
-    K_RMETA              <i>right meta</i>
-    K_LMETA              <i>left meta</i>
-    K_LSUPER             <i>left windows key</i>
-    K_RSUPER             <i>right windows key</i>
-    K_MODE               <i>mode shift</i>
-    K_HELP               <i>help</i>
-    K_PRINT              <i>print-screen</i>
-    K_SYSREQ             <i>SysRq</i>
-    K_BREAK              <i>break</i>
-    K_MENU               <i>menu</i>
-    K_POWER              <i>power</i>
-    K_EURO               <i>euro</i>
-<END>
-
-
-
-"modifiers"
-These constants represent the modifier keys on the keyboard.
-
-Their states are treated slightly differently than normal keyboard button states, and you can temporarily set their states.
- 
-    KMOD_NONE, KMOD_LSHIFT, KMOD_RSHIFT, KMOD_SHIFT, KMOD_CAPS,
-    KMOD_LCTRL, KMOD_RCTRL, KMOD_CTRL, KMOD_LALT, KMOD_RALT,
-    KMOD_ALT, KMOD_LMETA, KMOD_RMETA, KMOD_META, KMOD_NUM, KMOD_MODE
-<END>
-
-
-
-"time"
-These constants define the various time constants
-  
-    TIMER_RESOLUTION - minimum timer resolution in milliseconds
-<END>
-<END>

File src/pygamedocs.h

 
 #define DOC_PYGAMEKEYNAME "pygame.key.name(key): return string\nget the name of a key identifier"
 
-#define DOC_PYGAMECONTANTS "Pygame constants"
-
-#define DOC_DISPLAY "The following constants are used by the display module and Surfaces"
-
-#define DOC_EVENTS "These constants define the various event types"
-
-#define DOC_KEYBOARD "These constants represent the keys on the keyboard."
-
-#define DOC_MODIFIERS "These constants represent the modifier keys on the keyboard."
-
-#define DOC_TIME "These constants define the various time constants"
+#define DOC_PYGAMELOCALS "pygame constants"
 
 #define DOC_PYGAMEMASK "pygame module for image masks."
 
 
 
 
-pygame.contants
- Pygame constants
-
-
-
-display
- The following constants are used by the display module and Surfaces
-
-
-
-events
- These constants define the various event types
-
-
-
-keyboard
- These constants represent the keys on the keyboard.
-
-
-
-modifiers
- These constants represent the modifier keys on the keyboard.
-
-
-
-time
- These constants define the various time constants
+pygame.locals
+ pygame constants