Author: duncan
Date: Wed Aug  8 16:07:12 2007
New Revision: 9810

Log:
Made doc strings pydoctor friendly


Modified:
   branches/rel-1/freevo/src/animation/base.py
   branches/rel-1/freevo/src/animation/render.py

Modified: branches/rel-1/freevo/src/animation/base.py
==============================================================================
--- branches/rel-1/freevo/src/animation/base.py (original)
+++ branches/rel-1/freevo/src/animation/base.py Wed Aug  8 16:07:12 2007
@@ -39,11 +39,11 @@
     Base class for animations, this should perhaps be changed to use sprites
     in the future (if one decides to go with a RenderGroup model)
 
-     @rectstyle  : the rectangle defining the position on the screen (pygame)
-     @fps        : Desired fps
-     @bg_update  : update the animation with background from screen
-     @bg_wait    : initially wait for updated background before activating
-     @bg_redraw  : set background to original screen bg when finished
+    @rectstyle  : the rectangle defining the position on the screen (pygame)
+    @fps        : Desired fps
+    @bg_update  : update the animation with background from screen
+    @bg_wait    : initially wait for updated background before activating
+    @bg_redraw  : set background to original screen bg when finished
     """
 
     background   = None   # Surface Background (screen)
@@ -160,10 +160,8 @@
         """
         Checks if the screen background has been damaged
 
-        Note:
-            If the rect passed damages our rect, but no actual blit is done
-            on osd.screen, we'll end up with a copy of our animation in our
-            bg. This is BAD.
+        @notes: If the rect passed damages our rect, but no actual blit is done
+        on osd.screen, we'll end up with a copy of our animation in our bg. 
This is BAD.
         """
 
         if not (self.bg_redraw or self.bg_update) or rectstyles == None:

Modified: branches/rel-1/freevo/src/animation/render.py
==============================================================================
--- branches/rel-1/freevo/src/animation/render.py       (original)
+++ branches/rel-1/freevo/src/animation/render.py       Wed Aug  8 16:07:12 2007
@@ -67,15 +67,13 @@
     """
     This class/interface handles updating animation sprites
 
-    Problems:
-      How to do everything correctly so we don't end up with garbled screens.
-      Currently there's probably tons of problems with this.
-
-    Notes:
-      Perhaps we should utilize spritegroups for this, as it is supposed
-      to be optimized for this kind of stuff - pluss we get alot of code
-      for free. (ex. RenderUpdates). All animations objects would need to
-      extend the pygame.sprite.Sprite object.
+    @problems: How to do everything correctly so we don't end up with garbled
+    screens.  Currently there's probably tons of problems with this.
+
+    @notes: Perhaps we should utilize spritegroups for this, as it is supposed
+    to be optimized for this kind of stuff - pluss we get alot of code for 
free.
+    (ex. RenderUpdates). All animations objects would need to extend the
+    pygame.sprite.Sprite object.
     """
 
     animations   = []    # all animations

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog

Reply via email to