[aXSL-commit] SF.net SVN: axsl: [502] trunk/axsl/axsl-fotree/src/java/org/axsl/fotree/FONode.java

[<vic...@us...>]

Revision: 502
Author:   victormote
Date:     2006-05-04 14:54:38 -0700 (Thu, 04 May 2006)
ViewCVS:  http://svn.sourceforge.net/axsl/?rev=502&view=rev

Log Message:
-----------
Clean up doc a bit.

Modified Paths:
--------------
    trunk/axsl/axsl-fotree/src/java/org/axsl/fotree/FONode.java
Modified: trunk/axsl/axsl-fotree/src/java/org/axsl/fotree/FONode.java
===================================================================
--- trunk/axsl/axsl-fotree/src/java/org/axsl/fotree/FONode.java	2006-05-04 21:36:03 UTC (rev 501)
+++ trunk/axsl/axsl-fotree/src/java/org/axsl/fotree/FONode.java	2006-05-04 21:54:38 UTC (rev 502)
@@ -23,7 +23,7 @@
 import java.util.List;
 
 /**
- * Base class for nodes in the formatting object tree.
+ * Interface for nodes in the formatting object tree.
  */
 public interface FONode {
 
@@ -104,8 +104,16 @@
     public static final byte NODE_SVG_ELEMENT               = 75;
     public static final byte NODE_BOOKMARK_TREE             = 76;
 
+    /**
+     * Returns the parent of this node.
+     * @return This node's parent.
+     */
     public FObj parentFO();
 
+    /**
+     * Returns the children of this node.
+     * @return The children of this node, nor null if none exist.
+     */
     public List childrenFO();
 
     /**


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.