JavaDoc

2 files changed, 18 insertions, 10 deletions

diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractHoverInformationControlManager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractHoverInformationControlManager.java
index f9352942b4c..c9aa974cbab 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractHoverInformationControlManager.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractHoverInformationControlManager.java
@@ -47,8 +47,8 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 	
 	/**
 	 * The  information control closer for the hover information. Closes the information control as 
-	 * soon as the mouse pointer leaves the subject area, the user presses a key, or the subject
-	 * control is resized or moved.
+	 * soon as the mouse pointer leaves the subject area, a mouse button is pressed, the user presses a key,
+	 * or the subject control is resized or moved.
 	 */
 	class Closer extends MouseTrackAdapter 
 		implements IInformationControlCloser, MouseListener, MouseMoveListener, ControlListener, KeyListener {
@@ -131,7 +131,7 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 		}
 		
 		/*
-		 * @see MouseMoveListener#mouseMove
+		 * @see org.eclipse.swt.events.MouseMoveListener#mouseMove(org.eclipse.swt.events.MouseEvent)
 		 */
 		public void mouseMove(MouseEvent event) {
 			if (!fSubjectArea.contains(event.x, event.y))
@@ -139,7 +139,7 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 		}
 				
 		/*
-		 * @see MouseListener#mouseUp(MouseEvent)
+		 * @see org.eclipse.swt.events.MouseListener#mouseUp(org.eclipse.swt.events.MouseEvent)
 		 */
 		public void mouseUp(MouseEvent event) {
 		}
@@ -232,7 +232,7 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 		
 		/**
 		 * Sets this mouse tracker's subject area, the area to be tracked in order
-		 * to reenable the information control manager.
+		 * to re-enable the information control manager.
 		 * 
 		 * @param subjectArea the subject area
 		 */
@@ -275,6 +275,8 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 		 * to a small rectangle around the hover event location. Adds mouse move and shell activation listeners
 		 * to track whether the computed information is, after completion, useful for presentation and to
 		 * implement the restart function.
+		 * 
+		 * @param event the mouse hover event
 		 */
 		public void mouseHover(MouseEvent event) {
 			
@@ -362,7 +364,7 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 		
 		/**
 		 * Determines whether the computed information is still useful for presentation.
-		 * This is the case, if the shell of the subject control has been deactivated, the mouse
+		 * This is not the case, if the shell of the subject control has been deactivated, the mouse
 		 * left the subject control, or the mouse moved on, so that it is no longer in the subject
 		 * area.
 		 * 
@@ -466,6 +468,8 @@ abstract public class AbstractHoverInformationControlManager extends AbstractInf
 
  	/**
 	 * Returns the SWT event state of the most recent mouse hover event.
+	 * 
+	 * @return the SWT event state of the most recent mouse hover event
 	 */
 	protected int getHoverEventStateMask() {
 		return fHoverEventStateMask;
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java
index 0081e4bce95..125d5cbab8b 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java
@@ -31,6 +31,7 @@ import org.eclipse.swt.widgets.Control;
  * control are internally handled by the information control manager and are not the responsibility
  * of the information control closer.
  * 
+ * @see org.eclipse.jface.text.IInformationControl
  * @since 2.0
  */
 abstract public class AbstractInformationControlManager {
@@ -82,7 +83,7 @@ abstract public class AbstractInformationControlManager {
 	
 	
 	/**
-	 * Constitues entities to enumerate anchors for the layout of the information control.
+	 * Constitutes entities to enumerate anchors for the layout of the information control.
 	 */
 	public static final class Anchor {
 		private Anchor() {
@@ -100,7 +101,10 @@ abstract public class AbstractInformationControlManager {
 	public final static Anchor ANCHOR_LEFT=  ANCHORS[2];
 	/** Anchor representing the right side of the information area */
 	public final static Anchor ANCHOR_RIGHT= ANCHORS[3];
-	/** Anchor representing the middle of the subject control */
+	/** 
+	 * Anchor representing the middle of the subject control
+	 * @since 2.1
+	 */
 	public final static Anchor ANCHOR_GLOBAL= new Anchor();
 	
 	
@@ -212,11 +216,10 @@ abstract public class AbstractInformationControlManager {
 	 * the area for which the given information is valid. This so called subject area is a graphical
 	 * region of the information control's subject control. This method calls <code>presentInformation()</code>
 	 * to trigger the presentation of the computed information.
-	 * 
-	 * @since  2.1
 	 *
 	 * @param information the information
 	 * @param subjectArea the subject area
+	 * @since  2.1
 	 */
 	protected final void setInformation(Object information, Rectangle subjectArea) {
 		fInformation= information;
@@ -435,6 +438,7 @@ abstract public class AbstractInformationControlManager {
 	 * @param subjectArea the subject area
 	 * @param controlSize the size of the information control
 	 * @param anchor the anchor at the subject area
+	 * @return the display location of the information control
 	 */
 	protected Point computeLocation(Rectangle subjectArea, Point controlSize, Anchor anchor) {