Documentation update from php.net

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / IJavaAnnotation.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
index 5634c76..2e109ad 100644 (file)
--- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/IJavaAnnotation.java
@@ -12,47 +12,46 @@ package net.sourceforge.phpeclipse.phpeditor;
 
 import java.util.Iterator;
 
+import net.sourceforge.phpdt.core.ICompilationUnit;
+
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.swt.widgets.Display;
 
-import net.sourceforge.phpdt.core.ICompilationUnit;
-
 /**
- * Interface of annotations representing markers
- * and problems.
+ * Interface of annotations representing markers and problems.
  * 
  * @see org.eclipse.core.resources.IMarker
- * @see org.eclipse.jdt.core.compiler.IProblem
+ * @see net.sourceforge.phpdt.core.compiler.IProblem
  */
 public interface IJavaAnnotation {
-       
+
        /**
         * @see org.eclipse.jface.text.source.Annotation#getType()
         */
        String getType();
-       
+
        /**
         * @see org.eclipse.jface.text.source.Annotation#isPersistent()
         */
        boolean isPersistent();
-       
+
        /**
         * @see org.eclipse.jface.text.source.Annotation#isMarkedDeleted()
         */
        boolean isMarkedDeleted();
-       
+
        /**
-        * @see org.eclipse.jface.text.source.Annotation#getText() 
+        * @see org.eclipse.jface.text.source.Annotation#getText()
         */
        String getText();
-       
+
        /**
         * Returns whether this annotation is overlaid.
         * 
         * @return <code>true</code> if overlaid
         */
        boolean hasOverlay();
-       
+
        /**
         * Returns the overlay of this annotation.
         * 
@@ -60,48 +59,50 @@ public interface IJavaAnnotation {
         * @since 3.0
         */
        IJavaAnnotation getOverlay();
-       
+
        /**
-        * Returns an iterator for iterating over the
-        * annotation which are overlaid by this annotation.
+        * Returns an iterator for iterating over the annotation which are overlaid
+        * by this annotation.
         * 
         * @return an iterator over the overlaid annotaions
         */
        Iterator getOverlaidIterator();
-       
+
        /**
-        * Adds the given annotation to the list of
-        * annotations which are overlaid by this annotations.
-        *  
-        * @param annotation    the problem annoation
+        * Adds the given annotation to the list of annotations which are overlaid
+        * by this annotations.
+        * 
+        * @param annotation
+        *            the problem annoation
         */
        void addOverlaid(IJavaAnnotation annotation);
-       
+
        /**
-        * Removes the given annotation from the list of
-        * annotations which are overlaid by this annotation.
-        *  
-        * @param annotation    the problem annoation
+        * Removes the given annotation from the list of annotations which are
+        * overlaid by this annotation.
+        * 
+        * @param annotation
+        *            the problem annoation
         */
        void removeOverlaid(IJavaAnnotation annotation);
-       
+
        /**
-        * Tells whether this annotation is a problem
-        * annotation.
+        * Tells whether this annotation is a problem annotation.
         * 
         * @return <code>true</code> if it is a problem annotation
         */
        boolean isProblem();
-       
+
        /**
-        * Returns the compilation unit corresponding to the document on which the annotation is set
-        * or <code>null</code> if no corresponding co0mpilationunit exists.
+        * Returns the compilation unit corresponding to the document on which the
+        * annotation is set or <code>null</code> if no corresponding
+        * co0mpilationunit exists.
         */
        ICompilationUnit getCompilationUnit();
-       
+
        String[] getArguments();
-       
+
        int getId();
-       
+
        Image getImage(Display display);
 }