[ff-cvs] fenfire/org/fenfire/view VobWrapperFunction.java

[Matti Katila]

CVSROOT:        /cvsroot/fenfire
Module name:    fenfire
Branch:         
Changes by:     Matti Katila <address@hidden>   03/08/27 02:07:49

Modified files:
        org/fenfire/view: VobWrapperFunction.java 

Log message:
        doc

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/org/fenfire/view/VobWrapperFunction.java.diff?tr1=1.1&tr2=1.2&r1=text&r2=text

Patches:
Index: fenfire/org/fenfire/view/VobWrapperFunction.java
diff -u fenfire/org/fenfire/view/VobWrapperFunction.java:1.1 
fenfire/org/fenfire/view/VobWrapperFunction.java:1.2
--- fenfire/org/fenfire/view/VobWrapperFunction.java:1.1        Tue Aug 26 
07:34:41 2003
+++ fenfire/org/fenfire/view/VobWrapperFunction.java    Wed Aug 27 02:07:49 2003
@@ -5,19 +5,32 @@
 import org.nongnu.libvob.*;
 import org.nongnu.libvob.vobs.*;
 
-
+/** This node function places a vob. It needs another 
+ * nodefunction which returns Placeable object to get the size and 
+ * this size is used to construct ortho coordinate system, where
+ * the vob is placed. Placeable object is also placed and that
+ * makes a wrapper function of this by wrapping a vob and a placeable 
+ * object together.
+ * @see Placeable
+ */
 public class VobWrapperFunction implements NodeFunction {
     final NodeFunction function;
     final Vob vob;
 
-    /** Wraps nodefunction, which function returns Placeable object, with
-     * a vob.
+    /** Wrapper function used to wrap a vob and a placeable object.
+     * @param function A function which returns a Placeable object.
+     * @param vob The Vob used to place into ortho coordinate system
+     *            which is same size as the Placeable returned by 
+     *            the function.
+     * @see Placeable
      */
-    public VobWrapperFunction(NodeFunction func, Vob vob) {
-       this.function = func;
+    public VobWrapperFunction(NodeFunction function, Vob vob) {
+       this.function = function;
        this.vob = vob;
     }
     
+    /** @return A Placeable object.
+     */
     public Object f(final ConstGraph g, final Object node) {
        return new org.nongnu.libvob.lava.placeable.Placeable() {
                final org.nongnu.libvob.lava.placeable.Placeable content =