X-Git-Url: http://secure.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMCompilationUnit.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMCompilationUnit.java index 37f0537..1504b23 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMCompilationUnit.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMCompilationUnit.java @@ -11,54 +11,63 @@ package net.sourceforge.phpdt.core.jdom; /** - * Represents a Java compilation unit (.java source file). - * The corresponding syntactic unit is CompilationUnit (JLS2 7.3). - * Allowable child types for a compilation unit are IDOMPackage, IDOMImport, - * and IDOMType. + * Represents a Java compilation unit (.java source file). The + * corresponding syntactic unit is CompilationUnit (JLS2 7.3). Allowable child + * types for a compilation unit are IDOMPackage, + * IDOMImport, and IDOMType. *

* This interface is not intended to be implemented by clients. *

*/ public interface IDOMCompilationUnit extends IDOMNode { -/** - * Returns the header comment for this compilation unit. The header comment - * appears before the first declaration in a compilation unit. - * The syntax for a comment corresponds to Comments (JLS2 3.7), including - * comment delimiters. - * - * @return the header comment for this compilation unit, or null if - * no header comment is present - */ -public String getHeader(); -/** - * The IDOMCompilationNode refinement of this IDOMNode - * method returns the name of this compilation unit. - * - *

The name of a compilation unit is the name of the first top-level public type - * defined in the compilation unit, suffixed with ".java". For example, if the first - * top-level public type defined in this compilation unit has the name "Hanoi", - * then name of this compilation unit is "Hanoi.java".

- * - *

In the absence of a public top-level type, the name of the first top-level - * type is used. In the absence of any type, the name of the compilation unit - * is null.

- * - * @return the name of this compilation unit, or null if none - */ -public String getName(); -/** - * Sets the header comment for this compilation unit. The header comment - * appears before the first declaration in a compilation unit. - * The syntax for a comment corresponds to Comments (JLS2 3.7), including - * comment delimiters. - * - * @param comment the header comment for this compilation unit, or null if - * indicating no header comment - */ -public void setHeader(String comment); -/** - * The IDOMCompilationNode refinement of this IDOMNode - * method has no effect (the name is computed from the types declared within it). - */ -public void setName(String name); + /** + * Returns the header comment for this compilation unit. The header comment + * appears before the first declaration in a compilation unit. The syntax + * for a comment corresponds to Comments (JLS2 3.7), including + * comment delimiters. + * + * @return the header comment for this compilation unit, or + * null if no header comment is present + */ + public String getHeader(); + + /** + * The IDOMCompilationNode refinement of this + * IDOMNode method returns the name of this compilation unit. + * + *

+ * The name of a compilation unit is the name of the first top-level public + * type defined in the compilation unit, suffixed with ".java". For example, + * if the first top-level public type defined in this compilation unit has + * the name "Hanoi", then name of this compilation unit is "Hanoi.java". + *

+ * + *

+ * In the absence of a public top-level type, the name of the first + * top-level type is used. In the absence of any type, the name of the + * compilation unit is null. + *

+ * + * @return the name of this compilation unit, or null if none + */ + public String getName(); + + /** + * Sets the header comment for this compilation unit. The header comment + * appears before the first declaration in a compilation unit. The syntax + * for a comment corresponds to Comments (JLS2 3.7), including + * comment delimiters. + * + * @param comment + * the header comment for this compilation unit, or + * null if indicating no header comment + */ + public void setHeader(String comment); + + /** + * The IDOMCompilationNode refinement of this + * IDOMNode method has no effect (the name is computed from + * the types declared within it). + */ + public void setName(String name); }