*** empty log message ***

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / PHPDocument.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/PHPDocument.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/PHPDocument.java
index e3bc4c5..41200ae 100644 (file)
--- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/PHPDocument.java
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/PHPDocument.java
@@ -9,6 +9,7 @@ import java.util.ArrayList;
 
 /**
  * It's a php document.
+ * This class is an outlineable object
  * It will contains html and php
  * @author Matthieu Casanova
  */
@@ -20,7 +21,7 @@ public class PHPDocument implements OutlineableWithChildren {
    */
   public AstNode[] nodes;
 
-  /** The parent of the object */
+  /** The parent of the object. */
   public Object parent;
 
   /** The outlineable children (those will be in the node array too. */
@@ -28,6 +29,7 @@ public class PHPDocument implements OutlineableWithChildren {
 
   /**
    * Create the PHPDocument.
+   * @param parent the parent object (it should be null isn't it ?)
    */
   public PHPDocument(Object parent) {
     this.parent = parent;
@@ -70,8 +72,8 @@ public class PHPDocument implements OutlineableWithChildren {
   }
 
   /**
-   * The number of outlineable children
-   * @return
+   * The number of outlineable children.
+   * @return the number of children that are outlineable
    */
   public int size() {
     return children.size();
@@ -85,6 +87,10 @@ public class PHPDocument implements OutlineableWithChildren {
     return PHPUiImages.DESC_CLASS;
   }
 
+  /**
+   * Get the parent of the object.
+   * @return the parent of the object
+   */
   public Object getParent() {
     return parent;
   }