Updated Javadoc

10 files changed, 77 insertions, 52 deletions

diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindNextAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindNextAction.java
index f20137b4380..cf282ad364b 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindNextAction.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindNextAction.java
@@ -65,7 +65,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	private boolean fWholeWordInit;
 	
 	/**
-	 * Creates a new find/replace action for the given text editor. 
+	 * Creates a new find/replace action for the given workbench part. 
 	 * The action configures its visual representation from the given 
 	 * resource bundle.
 	 *
@@ -73,7 +73,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	 * @param prefix a prefix to be prepended to the various resource keys
 	 *   (described in <code>ResourceAction</code> constructor), or 
 	 *   <code>null</code> if none
-	 * @param editor the text editor
+	 * @param workbenchPart the workbench part
 	 * @param forward the search direction
 	 * @see ResourceAction#ResourceAction
 	 */
@@ -85,7 +85,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	}
 	
 	/**
-	 * Creates a new find/replace action for the given text editor. 
+	 * Creates a new find/replace action for the given workbench window. 
 	 * The action configures its visual representation from the given 
 	 * resource bundle.
 	 *
@@ -163,7 +163,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	}
 	
 	/*
-	 *	@see IAction#run
+	 *	@see IAction#run()
 	 */
 	public void run() {
 		if (fTarget != null) {
@@ -201,7 +201,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 		setEnabled(fTarget != null && fTarget.canPerformFind());
 	}
 
-	/**
+	/*
 	 * @see FindReplaceDialog#findIndex(String, int, boolean, boolean, boolean, boolean)
 	 */
 	private int findIndex(String findString, int startPosition, boolean forwardSearch, boolean caseSensitive, boolean wrapSearch, boolean wholeWord) {
@@ -229,6 +229,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	
 	/**
 	 * Returns whether the specified  search string can be found using the given options.
+	 * 
 	 * @param findString the string to search for
 	 * @param forwardSearch the search direction
 	 * @param caseSensitive should the search honor cases
@@ -288,7 +289,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	}
 
 	/**
-	 * Stores it current configuration in the dialog store.
+	 * Stores its current configuration in the dialog store.
 	 */
 	private void writeConfiguration() {
 		IDialogSettings s= getDialogSettings();
@@ -312,7 +313,7 @@ public class FindNextAction extends ResourceAction implements IUpdate {
 	}
 
 	/**
-	 * Returns the actual selection of the find replace target
+	 * Returns the actual selection of the find replace target.
 	 */
 	private String getSelectionString() {
 		
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceAction.java
index bee358badff..269c806be24 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceAction.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceAction.java
@@ -45,15 +45,20 @@ public class FindReplaceAction extends ResourceAction implements IUpdate {
 	 * target is retrieved from the active part using  
 	 * <code>getAdapter(IFindReplaceTarget.class)</code>.
 	 * <p>
-	 * The stub has the same life cycle as the find/replace dialog.
+	 * The stub has the same life cycle as the find/replace dialog.</p>
 	 */
 	class FindReplaceDialogStub implements IPartListener, DisposeListener {
 		
+		/** The workbench part */
 		private IWorkbenchPart fPart;
+		/** The previous workbench part */
 		private IWorkbenchPart fPreviousPart;
+		/** The previous find/replace target */
 		private IFindReplaceTarget fPreviousTarget;
 		
+		/** The workbench window */
 		private IWorkbenchWindow fWindow;
+		/** The find/replace dialog */
 		private FindReplaceDialog fDialog;
 		
 		/**
@@ -162,7 +167,7 @@ public class FindReplaceAction extends ResourceAction implements IUpdate {
 	private IWorkbenchWindow fWorkbenchWindow;
 
 	/**
-	 * Creates a new find/replace action for the given text editor. 
+	 * Creates a new find/replace action for the given workbench part. 
 	 * The action configures its visual representation from the given 
 	 * resource bundle.
 	 *
@@ -170,7 +175,7 @@ public class FindReplaceAction extends ResourceAction implements IUpdate {
 	 * @param prefix a prefix to be prepended to the various resource keys
 	 *   (described in <code>ResourceAction</code> constructor), or 
 	 *   <code>null</code> if none
-	 * @param editor the text editor
+	 * @param workbenchPart	 the workbench part
 	 * @see ResourceAction#ResourceAction
 	 */
 	public FindReplaceAction(ResourceBundle bundle, String prefix, IWorkbenchPart workbenchPart) {
@@ -180,7 +185,7 @@ public class FindReplaceAction extends ResourceAction implements IUpdate {
 	}
 	
 	/**
-	 * Creates a new find/replace action for the given text editor. 
+	 * Creates a new find/replace action for the given workbench window. 
 	 * The action configures its visual representation from the given 
 	 * resource bundle.
 	 *
@@ -200,7 +205,7 @@ public class FindReplaceAction extends ResourceAction implements IUpdate {
 	}
 	
 	/*
-	 *	@see IAction#run
+	 *	@see IAction#run()
 	 */
 	public void run() {
 		if (fTarget == null)
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceDialog.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceDialog.java
index 439d107f631..b74d44ebd88 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceDialog.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceDialog.java
@@ -201,7 +201,7 @@ class FindReplaceDialog extends Dialog {
 	
 	
 	/**
-	 * Returns <code>true</code> if control can be used
+	 * Returns <code>true</code> if control can be used.
 	 *
 	 * @param control the control to be checked
 	 * @return <code>true</code> if control can be used
@@ -211,7 +211,7 @@ class FindReplaceDialog extends Dialog {
 	}
 	
 	/*
-	 * @see Window#create
+	 * @see org.eclipse.jface.window.Window#create()
 	 */
 	public void create() {
 		
@@ -241,7 +241,7 @@ class FindReplaceDialog extends Dialog {
 	}
 
 	/**
-	 * Create the button section of the find/replace dialog
+	 * Create the button section of the find/replace dialog.
 	 *
 	 * @param parent the parent composite
 	 * @return the button section
@@ -329,7 +329,7 @@ class FindReplaceDialog extends Dialog {
 	}
 	
 	/*
-	 * @see Window#createContents
+	 * @see org.eclipse.jface.window.Window#createContents(org.eclipse.swt.widgets.Composite)
 	 */
 	protected Control createContents(Composite parent) {
 
@@ -499,8 +499,8 @@ class FindReplaceDialog extends Dialog {
 	}
 
 	/**
-	 * Create the panel where the user specifies the text to search
-	 * for and the optional replacement text
+	 * Creates the panel where the user specifies the text to search
+	 * for and the optional replacement text.
 	 *
 	 * @param parent the parent composite
 	 * @return the input panel
@@ -679,7 +679,7 @@ class FindReplaceDialog extends Dialog {
 	}
 	
 	/**
-	 * Returns whether the specified  search string can be found using the given options.
+	 * Returns whether the specified search string can be found using the given options.
 	 * 
 	 * @param findString the string to search for
 	 * @param forwardSearch the direction of the search
@@ -769,7 +769,7 @@ class FindReplaceDialog extends Dialog {
 	// ------- init / close ---------------------------------------
 
 	/**
-	 * Returns the actual selection of the find replace target
+	 * Returns the actual selection of the find replace target.
 	 * @return the selection of the target
 	 */
 	private String getSelectionString() {
@@ -789,8 +789,8 @@ class FindReplaceDialog extends Dialog {
 		return null;
 	}
 	
-	/*
-	 * @see Window#close()
+	/**
+	 * @see org.eclipse.jface.window.Window#close()
 	 */
 	public boolean close() {
 		handleDialogClose();
@@ -1173,7 +1173,7 @@ class FindReplaceDialog extends Dialog {
 	// ------- ui creation ---------------------------------------
 	
 	/**
-	 * Attaches the given layout specification to the <code>component</code>
+	 * Attaches the given layout specification to the <code>component</code>.
 	 * 
 	 * @param component the component
 	 * @param horizontalAlignment horizontal alignment
@@ -1228,7 +1228,7 @@ class FindReplaceDialog extends Dialog {
 	// ------- open / reopen ---------------------------------------
 	
 	/**
-	 * Called after executed find/replace action to update the history
+	 * Called after executed find/replace action to update the history.
 	 */
 	private void updateFindAndReplaceHistory() {
 		updateFindHistory();
@@ -1239,7 +1239,7 @@ class FindReplaceDialog extends Dialog {
 	}
 
 	/**
-	 * Called after executed find action to update the history
+	 * Called after executed find action to update the history.
 	 */
 	private void updateFindHistory() {
 		if (okToUse(fFindField)) {
@@ -1268,7 +1268,7 @@ class FindReplaceDialog extends Dialog {
 	}
 	
 	/**
-	 * Returns whether the target is editable
+	 * Returns whether the target is editable.
 	 * @return <code>true</code> if target is editable
 	 */
 	private boolean isEditable() {
@@ -1332,7 +1332,7 @@ class FindReplaceDialog extends Dialog {
 	//--------------- configuration handling --------------
 	
 	/**
-	 * Returns the dialog settings object used to share state 
+	 * Returns the dialog settings object used to share state
 	 * between several find/replace dialogs.
 	 * 
 	 * @return the dialog settings to be used
@@ -1384,7 +1384,7 @@ class FindReplaceDialog extends Dialog {
 	}
 	
 	/**
-	 * Stores it current configuration in the dialog store.
+	 * Stores its current configuration in the dialog store.
 	 */
 	private void writeConfiguration() {
 		IDialogSettings s= getDialogSettings();
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceTarget.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceTarget.java
index f192016669d..dd1f25db77b 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceTarget.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceTarget.java
@@ -24,25 +24,43 @@ import org.eclipse.jface.text.IRegion;
  */
 class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtension, IFindReplaceTargetExtension2 {
 	
+	/** The editor */
 	private AbstractTextEditor fEditor;
+	/** The find/replace target */
 	private IFindReplaceTarget fTarget;
 
+	/**
+	 * Creates a new find/replace target.
+	 * 
+	 * @param editor the editor
+	 * @param target the wrapped find/replace target
+	 */
 	public FindReplaceTarget(AbstractTextEditor editor, IFindReplaceTarget target) {
 		fEditor= editor;
 		fTarget= target;
 	}
 	
+	/**
+	 * Returns the wrapped find/replace target.
+	 * 
+	 * @return the wrapped find/replace target
+	 */
 	private IFindReplaceTarget getTarget() {
 		return fTarget;
 	}
 	
+	/**
+	 * Returns the find/replace target extension.
+	 * 
+	 * @return the find/replace target extension
+	 */
 	private IFindReplaceTargetExtension getExtension() {
 		if (fTarget instanceof IFindReplaceTargetExtension)
 			return (IFindReplaceTargetExtension) fTarget;
 		return null;
 	}
 	
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#canPerformFind()
 	 */
 	public boolean canPerformFind() {
@@ -51,7 +69,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return false;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#findAndSelect(int, java.lang.String, boolean, boolean, boolean)
 	 */
 	public int findAndSelect(int offset, String findString, boolean searchForward, boolean caseSensitive, boolean wholeWord) {
@@ -60,7 +78,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return -1;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#getSelection()
 	 */
 	public Point getSelection() {
@@ -69,7 +87,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return null;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#getSelectionText()
 	 */
 	public String getSelectionText() {
@@ -78,7 +96,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return null;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#isEditable()
 	 */
 	public boolean isEditable() {
@@ -90,7 +108,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return false;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTarget#replaceSelection(java.lang.String)
 	 */
 	public void replaceSelection(String text) {
@@ -98,7 +116,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getTarget().replaceSelection(text);
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#beginSession()
 	 */
 	public void beginSession() {
@@ -106,7 +124,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().beginSession();
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#endSession()
 	 */
 	public void endSession() {
@@ -114,7 +132,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().endSession();
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#getScope()
 	 */
 	public IRegion getScope() {
@@ -123,7 +141,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return null;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#setScope(org.eclipse.jface.text.IRegion)
 	 */
 	public void setScope(IRegion scope) {
@@ -131,7 +149,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().setScope(scope);
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#getLineSelection()
 	 */
 	public Point getLineSelection() {
@@ -140,7 +158,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 		return null;
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#setSelection(int, int)
 	 */
 	public void setSelection(int offset, int length) {
@@ -148,7 +166,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().setSelection(offset, length);
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#setScopeHighlightColor(org.eclipse.swt.graphics.Color)
 	 */
 	public void setScopeHighlightColor(Color color) {
@@ -156,7 +174,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().setScopeHighlightColor(color);
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.jface.text.IFindReplaceTargetExtension#setReplaceAllMode(boolean)
 	 */
 	public void setReplaceAllMode(boolean replaceAll) {
@@ -164,7 +182,7 @@ class FindReplaceTarget implements IFindReplaceTarget, IFindReplaceTargetExtensi
 			getExtension().setReplaceAllMode(replaceAll);
 	}
 
-	/* (non-Javadoc)
+	/*
 	 * @see org.eclipse.ui.texteditor.IFindReplaceTargetExtension2#validateTargetState()
 	 */
 	public boolean validateTargetState() {
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java
index 96f0aa1038e..e8e1e136077 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java
@@ -84,7 +84,7 @@ public class GotoLineAction extends TextEditorAction {
 	class GotoLineDialog extends InputDialog {
 		
 		/*
-		 * @see InputDialog#InputDialog
+		 * @see InputDialog#InputDialog(org.eclipse.swt.widgets.Shell, java.lang.String, java.lang.String, java.lang.String, org.eclipse.jface.dialogs.IInputValidator)
 		 */
 		public GotoLineDialog(Shell parent, String title, String message, String initialValue, IInputValidator validator) {
 			super(parent, title, message, initialValue, validator);
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension.java
index bc0efffa651..bc28f1d8893 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension.java
@@ -72,6 +72,7 @@ public interface IDocumentProviderExtension {
 	 * Returns whether the state of the given element has been validated.
 	 * 
 	 * @param element the element
+	 * @return <code>true</code> if the state has been validated
 	 */
 	boolean isStateValidated(Object element);
 	
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IFindReplaceTargetExtension2.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IFindReplaceTargetExtension2.java
index 9b1c86b6149..db53a4dea6a 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IFindReplaceTargetExtension2.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IFindReplaceTargetExtension2.java
@@ -21,8 +21,9 @@ public interface IFindReplaceTargetExtension2 {
 	/**
 	 * Validates the state of this target. The predominate intent of this method
 	 * is to take any action propably necessary to ensure that the target can
-	 * persistently be changed. Returns <code>true</code> if the target was
-	 * validated, <code>false</code> otherwise.
+	 * persistently be changed.
+	 * 
+	 * @return <code>true</code> if the target was validated, <code>false</code> otherwise
 	 */
 	boolean validateTargetState();
 }
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IMarkerUpdater.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
index 505f1463a9a..04ce65f8548 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
@@ -48,12 +48,12 @@ public interface IMarkerUpdater {
 	/**
 	 * Updates the given marker according to the position of the given document.
 	 * If the given position is <code>null</code>, the marker is assumed to
-	 * carry the correct positional information. If the updater recognizes that
-	 * the marker should be deleted, it returns <code>false</code>.
+	 * carry the correct positional information.
 	 *
 	 * @param marker the marker to be updated
 	 * @param document the document into which the given position points
 	 * @param position the current position of the marker inside the given document
+	 * @return  <code>false</code> if the updater recognizes that the marker should be deleted
 	 */
 	boolean updateMarker(IMarker marker, IDocument document, Position position);
 }
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
index dbfc083db53..aca58ec0489 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
@@ -65,9 +65,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
 	 * Context menu group for actions which do not fit in one of the other categories. 
 	 * Value: <code>"group.rest"</code>
 	 */
-	static final String GROUP_REST= "group.rest"; //$NON-NLS-1$	
-	
-	
+	static final String GROUP_REST= "group.rest"; //$NON-NLS-1$
 	
 	/** 
 	 * Name of the action for shifting text blocks to the right. 
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorExtension2.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorExtension2.java
index 0f5fa87db3a..6ac3c3a48a7 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorExtension2.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorExtension2.java
@@ -38,7 +38,8 @@ public interface ITextEditorExtension2 {
 	 * Validates the state of the given editor input. The predominate intent
 	 * of this method is to take any action propably necessary to ensure that
 	 * the input can persistently be changed.
-	 * Returns <code>true</code> if the input was validated, <code>false</code> otherwise.
+	 * 
+	 * @return <code>true</code> if the input was validated, <code>false</code> otherwise
 	 */
 	boolean validateEditorInputState();