[ff-cvs] libvob/org/nongnu/libvob/buoy BuoyLinkListener....

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/libvob
Module name:    libvob
Branch:         
Changes by:     Tuomas J. Lukka <address@hidden>        03/08/15 05:25:56

Modified files:
        org/nongnu/libvob/buoy: BuoyLinkListener.java 
                                BuoyViewConnector.java 

Log message:
        doc

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java.diff?tr1=1.2&tr2=1.3&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/libvob/libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java.diff?tr1=1.2&tr2=1.3&r1=text&r2=text

Patches:
Index: libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java
diff -u libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java:1.2 
libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java:1.3
--- libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java:1.2     Fri May 23 
16:48:49 2003
+++ libvob/org/nongnu/libvob/buoy/BuoyLinkListener.java Fri Aug 15 05:25:56 2003
@@ -30,15 +30,28 @@
 import org.nongnu.libvob.*;
 
 /** A callback interface for placing buoy links.
+ * @see BuoyViewConnector
  */
 public interface BuoyLinkListener {
+
     /** A buoy link was found.
+     * @param dir Usually -1 or 1 for left and right
+     * @param anchorCS The coordinate system of the anchor inside the main 
view.
+     * @param otherNodeType The node type to be rendered as the buoy
+     * @param linkId The identity of the link. This is used for interpolation:
+     *                         this object needs to be the same for the link
+     *                         *in both directions*. No other restrictions,
+     *                         and no-one should ever look inside a linkId 
object
+     *                         so it's private to the BuoyViewConnector
+     * @param otherAnchor The anchor inside the buoy. This will be passed to 
otherNodeType
+     *                         for it to know what the object to be rendered 
actually is.
      */
-    void link(int dir, int anchorCS, BuoyViewNodeType otherNode, 
+    void link(int dir, int anchorCS, BuoyViewNodeType otherNodeType, 
            Object linkId, Object otherAnchor);
 
 
-    /** Many buoy links were found.
+    /** A buoy links were found.
+     * See the other method for the rest of the parameters.
      * @param count is count of buoys from the anchor.
      */
     void link(int dir, int anchorCS, BuoyViewNodeType otherNode, 
Index: libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java
diff -u libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java:1.2 
libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java:1.3
--- libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java:1.2    Fri Apr 25 
09:41:58 2003
+++ libvob/org/nongnu/libvob/buoy/BuoyViewConnector.java        Fri Aug 15 
05:25:56 2003
@@ -40,8 +40,12 @@
      *  main node has already rendered itself into.
      *  This method traverses the structure created
      *  by the main node and adds buoys accordingly.
+     *  @param vs The vobscene
+     *  @param cs The coordinate system that the main node was rendered into
+     *  @param mainNode The main node object that was rendered
+     *  @param linkListener The object to call for making buoys
      */
     void addBuoys(VobScene vs, int cs,
                  BuoyViewMainNode mainNode,
-                 BuoyLinkListener into);
+                 BuoyLinkListener linkListener);
 }