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

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/libvob
Module name:    libvob
Branch:         
Changes by:     Tuomas J. Lukka <address@hidden>        03/09/04 04:19:13

Modified files:
        org/nongnu/libvob/buoy: BuoyGeometryConfiguration.java 

Log message:
        javadoc

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

Patches:
Index: libvob/org/nongnu/libvob/buoy/BuoyGeometryConfiguration.java
diff -u libvob/org/nongnu/libvob/buoy/BuoyGeometryConfiguration.java:1.1 
libvob/org/nongnu/libvob/buoy/BuoyGeometryConfiguration.java:1.2
--- libvob/org/nongnu/libvob/buoy/BuoyGeometryConfiguration.java:1.1    Mon Aug 
11 03:34:54 2003
+++ libvob/org/nongnu/libvob/buoy/BuoyGeometryConfiguration.java        Thu Sep 
 4 04:19:13 2003
@@ -25,7 +25,13 @@
     public BuoyGeometer getGeometer(BuoyViewMainNode node,
                        BuoyViewConnector connector);
 
-    /** Get the set of geometers (for preparing).
+    /** Get the set of all BuoyGeometers (for preparing).
+     * This method returns a set containing all BuoyGeometer
+     * objects that can be returned by the getGeometer method
+     * of this object for any parameters.
+     * The point is that the BuoyGeometer.prepare() method has to be
+     * called exactly once for each, and this method gives
+     * all of them conveniently set up for iteration.
      */
     public Set getGeometers(BuoyViewMainNode node);
 }