[ff-cvs] libvob/doc/pegboard/animation_api--mudyc peg.rst

[Matti Katila]

CVSROOT:        /cvsroot/libvob
Module name:    libvob
Branch:         
Changes by:     Matti Katila <address@hidden>   03/10/15 06:02:50

Modified files:
        doc/pegboard/animation_api--mudyc: peg.rst 

Log message:
        antont\'s comments

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/doc/pegboard/animation_api--mudyc/peg.rst.diff?tr1=1.6&tr2=1.7&r1=text&r2=text

Patches:
Index: libvob/doc/pegboard/animation_api--mudyc/peg.rst
diff -u libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.6 
libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.7
--- libvob/doc/pegboard/animation_api--mudyc/peg.rst:1.6        Wed Oct 15 
05:22:36 2003
+++ libvob/doc/pegboard/animation_api--mudyc/peg.rst    Wed Oct 15 06:02:49 2003
@@ -5,8 +5,8 @@
 
 :Authors:  mudyc
 :Date-Created: 2003-09-27
-:Last-Modified: $Date: 2003/10/15 09:22:36 $
-:Revision: $Revision: 1.6 $
+:Last-Modified: $Date: 2003/10/15 10:02:49 $
+:Revision: $Revision: 1.7 $
 :Status:   Current
 :Stakeholders: mudyc, tjl, benja
 :Scope:    Minor
@@ -34,7 +34,7 @@
 Issues
 ======
 
-ISSUE: How can we make sure that none other object call the public method 
+ISSUE: How can we make sure that no other object calls the public method 
 AbstractUpdateManager.chg()?
 
    RESOLVED: Use the source, Luke. Yes, we have source and we can 
@@ -47,8 +47,8 @@
 
     Small demos might still need these methods.
     Otoh, safer is better. One possibility is to 
-    add this API with in demo framework but then it would be
-    very hard to call from java side.
+    add this API within the demo framework but then it would be
+    very hard to call from the java side.
 
 
 Changes
@@ -73,7 +73,7 @@
      * This interface encapsulates the low-level animation interface
      * such as AbstractUpdateManagers' chg and setNoAnimation methods. 
      * <p>
-     * This interface set strict policy for several routines.
+     * This interface sets strict policy for several routines.
      *
      *   1) There must not be other place to get previous/last 
      *      VobScene. If a VobScene is saved in other place than 
@@ -83,7 +83,7 @@
      * 
      *   2) There must not be objects that call low-level animation 
      *      interface to change animation state. This could prevent
-     *      proper animation, e.g., by setting no animation even
+     *      proper animation, e.g., by setting no animation even when
      *      animation should be done.
      */
     public interface AnimationAPI {
@@ -101,22 +101,23 @@
 
 
         /** Rerender the current VobScene. 
-         * Changes in next frame is seen if coordinate system
-         * parameters are set. Rerendering current VobScene 
+         * Changes in next frame are seen if coordinate system
+         * parameters are set. Rerendering the current VobScene 
          * is much faster than creating a new VobScene, 
          * so e.g., any drag actions should be implemented to use
          * this method. 
         * <p>
-         * Even new coordinate systems can be created, the current 
+         * Even though new coordinate systems can be created, the current 
          * coorder implementation uses finite range of coordinate systems, 
-        * and creating too many new coordinate systems leads to
+        * And creating too many new coordinate systems leads to
          * undefined behauviour.
+        * @see VobCoorder
          */
         void rerender(String caller);
  
 
        /** Get the current visible vobscene. 
-         * While programming, you are creating vobscene
+         * When programming, you create vobscenes
          * for future usually, so this returns the obivious previous 
          * vobscene, e.g., to set coordinate system parameters.
          */
@@ -125,8 +126,8 @@
 
        /** Returns true if VobScene has changed from previous
          * <code> animate</code> or <code>switchVS</code> method.
-         * In some situations when handling the events programmer 
-         * need to know whether the VobScene is new or the still the old one.
+         * In some situations when handling the events the programmer 
+         * needs to know whether the VobScene is new or the still the old one.
         */
        boolean hasVSchanged();
     }