diff options
| author | Dani Megert | 2008-08-26 14:13:28 +0000 |
|---|---|---|
| committer | Dani Megert | 2008-08-26 14:13:28 +0000 |
| commit | 79f56bc4dc02ac17a2551f00fe5a77c8695c06ca (patch) | |
| tree | 0b5a4374fa7597954c9179e22eda82af018e60fb | |
| parent | 7cf852d27f88fa7f7905004439c5e5106c21d0c0 (diff) | |
| download | eclipse.platform.text-79f56bc4dc02ac17a2551f00fe5a77c8695c06ca.tar.gz eclipse.platform.text-79f56bc4dc02ac17a2551f00fe5a77c8695c06ca.tar.xz eclipse.platform.text-79f56bc4dc02ac17a2551f00fe5a77c8695c06ca.zip | |
Warn about missing description for all standard tags.
72 files changed, 566 insertions, 603 deletions
diff --git a/org.eclipse.jface.text.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.jface.text.tests/.settings/org.eclipse.jdt.core.prefs index b446c773f1c..787aa457c53 100644 --- a/org.eclipse.jface.text.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.jface.text.tests/.settings/org.eclipse.jdt.core.prefs @@ -56,6 +56,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
diff --git a/org.eclipse.jface.text/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.jface.text/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..43882455143 100644 --- a/org.eclipse.jface.text/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.jface.text/.settings/org.eclipse.jdt.core.prefs @@ -1,4 +1,4 @@ -#Tue Jul 15 15:50:55 CEST 2008
+#Tue Aug 26 14:45:20 CEST 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.builder.cleanOutputFolder=clean
org.eclipse.jdt.core.builder.duplicateResourceTask=warning
@@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/IContentAssistSubjectControl.java b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/IContentAssistSubjectControl.java index 6a6a577af5f..8569be998a8 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/IContentAssistSubjectControl.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/IContentAssistSubjectControl.java @@ -39,7 +39,7 @@ public interface IContentAssistSubjectControl { * Returns the line height. * * @return line height in pixel - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been * disposed</li> @@ -55,7 +55,7 @@ public interface IContentAssistSubjectControl { * * @return the caret position relative to the start of the text in widget * coordinates - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been * disposed</li> @@ -74,7 +74,7 @@ public interface IContentAssistSubjectControl { * <= offset <= getCharCount() * @return x, y location of the upper left corner of the character bounding * box at the specified offset in the text - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been disposed</li> * <li>{@link org.eclipse.swt.SWT#ERROR_THREAD_INVALID_ACCESS} - if not called from the thread that created the receiver</li> @@ -89,7 +89,7 @@ public interface IContentAssistSubjectControl { * * @return line delimiter used for entering new lines by key down or paste * operation - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been disposed</li> * <li>{@link org.eclipse.swt.SWT#ERROR_THREAD_INVALID_ACCESS} - if not called from the thread that created the receiver</li> @@ -101,7 +101,7 @@ public interface IContentAssistSubjectControl { * Returns the selected range in the subject's widget. * * @return start and length of the selection, x is the offset of the - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been disposed</li> * <li>{@link org.eclipse.swt.SWT#ERROR_THREAD_INVALID_ACCESS} - if not called from the thread that created the receiver</li> @@ -199,7 +199,7 @@ public interface IContentAssistSubjectControl { * * @param keyListener the listener which should be notified * @exception IllegalArgumentException if the listener is <code>null</code> - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been disposed</li> * <li>{@link org.eclipse.swt.SWT#ERROR_THREAD_INVALID_ACCESS} - if not called from the thread that created the receiver</li> @@ -216,7 +216,7 @@ public interface IContentAssistSubjectControl { * * @param keyListener the listener which should be notified * @exception IllegalArgumentException if the listener is null</li> - * @exception org.eclipse.swt.SWTException + * @throws org.eclipse.swt.SWTException in these cases: * <ul> * <li>{@link org.eclipse.swt.SWT#ERROR_WIDGET_DISPOSED} - if the receiver has been disposed</li> * <li>{@link org.eclipse.swt.SWT#ERROR_THREAD_INVALID_ACCESS} - if not called from the thread that created the receiver</li> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/HTMLTextPresenter.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/HTMLTextPresenter.java index b5f4e9e6ce2..d28c5b055f0 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/HTMLTextPresenter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/HTMLTextPresenter.java @@ -21,6 +21,7 @@ import org.eclipse.swt.graphics.GC; import org.eclipse.swt.widgets.Display; import org.eclipse.jface.internal.text.link.contentassist.LineBreakingReader; + import org.eclipse.jface.text.DefaultInformationControl; import org.eclipse.jface.text.Region; import org.eclipse.jface.text.TextPresentation; @@ -98,8 +99,10 @@ public class HTMLTextPresenter implements DefaultInformationControl.IInformation /** * {@inheritDoc} * - * @see org.eclipse.jface.text.DefaultInformationControl.IInformationPresenter#updatePresentation(org.eclipse.swt.widgets.Display, java.lang.String, org.eclipse.jface.text.TextPresentation, int, int) - * @deprecated + * @see org.eclipse.jface.text.DefaultInformationControl.IInformationPresenter#updatePresentation(org.eclipse.swt.widgets.Display, + * java.lang.String, org.eclipse.jface.text.TextPresentation, int, int) + * @deprecated Use {@link #updatePresentation(Drawable, String, TextPresentation, int, int)} + * instead */ public String updatePresentation(Display display, String hoverInfo, TextPresentation presentation, int maxWidth, int maxHeight) { return updatePresentation((Drawable)display, hoverInfo, presentation, maxWidth, maxHeight); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java index b9b877096bb..a767e6dd57f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java @@ -1467,7 +1467,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx } /** - * @param completionPosition + * @param completionPosition the completion position */ public void setCompletionPosition(int completionPosition) { fCompletionPosition= completionPosition; @@ -1481,14 +1481,14 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx } /** - * @param proposals + * @param proposals the proposals */ public void setCompletions(String[] proposals) { fProposalStrings= proposals; } /** - * @param proposals + * @param proposals the proposals */ public void setCompletions(ICompletionProposal[] proposals) { fProposals= proposals; @@ -1536,7 +1536,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx } /** - * @param proposal + * @param proposal the proposal */ public void fireProposalChosen(ICompletionProposal proposal) { List list= new ArrayList(fProposalListeners); @@ -1548,14 +1548,14 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx } /** - * @param listener + * @param listener the proposal listener */ public void removeProposalListener(IProposalListener listener) { fProposalListeners.remove(listener); } /** - * @param listener + * @param listener the proposal listener */ public void addProposalListener(IProposalListener listener) { fProposalListeners.add(listener); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/IProposalListener.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/IProposalListener.java index 28ad7089d2d..ba0e40639d8 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/IProposalListener.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/IProposalListener.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -19,7 +19,7 @@ import org.eclipse.jface.text.contentassist.ICompletionProposal; public interface IProposalListener { /** - * @param proposal + * @param proposal the completion proposal */ void proposalChosen(ICompletionProposal proposal); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/LineBreakingReader.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/LineBreakingReader.java index 09639e4465e..4c9eabdf4bf 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/LineBreakingReader.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/LineBreakingReader.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -16,6 +16,7 @@ import java.io.IOException; import java.io.Reader; import com.ibm.icu.text.BreakIterator; + import org.eclipse.swt.graphics.GC; /* @@ -55,11 +56,10 @@ public class LineBreakingReader { } /** - * Reads the next line. The lengths of the line will not exceed the given maximum - * width. + * Reads the next line. The lengths of the line will not exceed the given maximum width. * - * @return the next line - * @throws IOException + * @return the next line + * @throws IOException if an I/O error occurs */ public String readLine() throws IOException { if (fLine == null) { 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 10138289e91..1dd6b6cfe59 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 @@ -13,9 +13,6 @@ package org.eclipse.jface.text; -import org.eclipse.core.runtime.Assert; -import org.eclipse.core.runtime.Platform; - import org.eclipse.swt.SWT; import org.eclipse.swt.events.DisposeEvent; import org.eclipse.swt.events.DisposeListener; @@ -26,12 +23,16 @@ import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Monitor; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.Platform; + import org.eclipse.jface.dialogs.IDialogSettings; import org.eclipse.jface.internal.text.InformationControlReplacer; import org.eclipse.jface.internal.text.InternalAccessor; -import org.eclipse.jface.text.ITextViewerExtension8.EnrichMode; import org.eclipse.jface.util.Geometry; +import org.eclipse.jface.text.ITextViewerExtension8.EnrichMode; + /** * Manages the life cycle, visibility, layout, and contents of an @@ -524,26 +525,25 @@ abstract public class AbstractInformationControlManager { } /** - * Tells this information control manager to open the information - * control with the values contained in the given dialog settings - * and to store the control's last valid size in the given dialog - * settings. + * Tells this information control manager to open the information control with the values + * contained in the given dialog settings and to store the control's last valid size in the + * given dialog settings. * <p> * Note: This API is only valid if the information control implements - * {@link IInformationControlExtension3}. Not following this restriction - * will later result in an {@link UnsupportedOperationException}. + * {@link IInformationControlExtension3}. Not following this restriction will later result in an + * {@link UnsupportedOperationException}. * </p> * <p> * The constants used to store the values are: * <ul> - * <li>{@link AbstractInformationControlManager#STORE_LOCATION_X}</li> - * <li>{@link AbstractInformationControlManager#STORE_LOCATION_Y}</li> - * <li>{@link AbstractInformationControlManager#STORE_SIZE_WIDTH}</li> - * <li>{@link AbstractInformationControlManager#STORE_SIZE_HEIGHT}</li> + * <li>{@link AbstractInformationControlManager#STORE_LOCATION_X}</li> + * <li>{@link AbstractInformationControlManager#STORE_LOCATION_Y}</li> + * <li>{@link AbstractInformationControlManager#STORE_SIZE_WIDTH}</li> + * <li>{@link AbstractInformationControlManager#STORE_SIZE_HEIGHT}</li> * </ul> * </p> - * - * @param dialogSettings + * + * @param dialogSettings the dialog settings * @param restoreLocation <code>true</code> iff the location is must be (re-)stored * @param restoreSize <code>true</code>iff the size is (re-)stored * @since 3.0 @@ -1210,7 +1210,7 @@ abstract public class AbstractInformationControlManager { /** * Crops the given bounds such that they lie completely on the closest monitor. - * + * * @param bounds shell bounds to crop * @since 3.4 */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/ISelectionValidator.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/ISelectionValidator.java index 16dc1d59f05..18fc413d98e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/ISelectionValidator.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/ISelectionValidator.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -31,8 +31,8 @@ public interface ISelectionValidator { /** * Tests whether the given post selection is still valid. - * - * @param selection + * + * @param selection the selection * @return <code>true</code> if the selection is still valid */ boolean isValid(ISelection selection); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java index 1219195eae1..ebceff9a145 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java @@ -4756,17 +4756,15 @@ public class TextViewer extends Viewer implements } /** - * Basically same functionality as - * <code>ITextViewerExtension.setRedraw(boolean)</code>. Adds a way for - * subclasses to pass in a desired top index that should be used when - * <code>redraw</code> is <code>true</code>. If <code>topIndex</code> - * is -1, this method is identical to - * <code>ITextViewerExtension.setRedraw(boolean)</code>. - * + * Basically same functionality as <code>ITextViewerExtension.setRedraw(boolean)</code>. Adds a + * way for subclasses to pass in a desired top index that should be used when + * <code>redraw</code> is <code>true</code>. If <code>topIndex</code> is -1, this method is + * identical to <code>ITextViewerExtension.setRedraw(boolean)</code>. + * * @see ITextViewerExtension#setRedraw(boolean) - * - * @param redraw - * @param topIndex + * + * @param redraw <code>true</code> if redraw is enabled + * @param topIndex the top index * @since 3.0 */ protected final void setRedraw(boolean redraw, int topIndex) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java index 02fd346342f..2356e62c295 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java @@ -24,7 +24,7 @@ import org.eclipse.swt.graphics.Point; /** - * A painter for drawing visible characters for (invisible) whitespace + * A painter for drawing visible characters for (invisible) whitespace * characters. * * @since 3.3 @@ -130,14 +130,8 @@ public class WhitespaceCharacterPainter implements IPainter, PaintListener { } } - /** + /* * Draw characters in view range. - * - * @param gc - * @param x - * @param y - * @param w - * @param h */ private void handleDrawRequest(GC gc, int x, int y, int w, int h) { int startLine= fTextWidget.getLineIndex(y); @@ -156,11 +150,11 @@ public class WhitespaceCharacterPainter implements IPainter, PaintListener { /** * Draw the given line range. * - * @param gc - * @param startLine first line number - * @param endLine last line number (inclusive) - * @param x the X-coordinate of the drawing range - * @param w the width of the drawing range + * @param gc the GC + * @param startLine first line number + * @param endLine last line number (inclusive) + * @param x the X-coordinate of the drawing range + * @param w the width of the drawing range */ private void drawLineRange(GC gc, int startLine, int endLine, int x, int w) { final int viewPortWidth= fTextWidget.getClientArea().width; @@ -319,7 +313,7 @@ public class WhitespaceCharacterPainter implements IPainter, PaintListener { /** * Draw string at widget offset. * - * @param gc + * @param gc the GC * @param offset the widget offset * @param s the string to be drawn * @param fg the foreground color @@ -339,7 +333,7 @@ public class WhitespaceCharacterPainter implements IPainter, PaintListener { /** * Convert a document offset to the corresponding widget offset. * - * @param documentOffset + * @param documentOffset the document offset * @return widget offset */ private int getWidgetOffset(int documentOffset) { @@ -358,7 +352,7 @@ public class WhitespaceCharacterPainter implements IPainter, PaintListener { /** * Convert a widget offset to the corresponding document offset. * - * @param widgetOffset + * @param widgetOffset the widget offset * @return document offset */ private int getDocumentOffset(int widgetOffset) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/CompletionProposalPopup.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/CompletionProposalPopup.java index dcc1e7b32c1..b186776fc24 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/CompletionProposalPopup.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/CompletionProposalPopup.java @@ -14,13 +14,6 @@ package org.eclipse.jface.text.contentassist; import java.util.ArrayList; import java.util.List; -import org.eclipse.core.runtime.Assert; - -import org.eclipse.core.commands.AbstractHandler; -import org.eclipse.core.commands.ExecutionEvent; -import org.eclipse.core.commands.ExecutionException; -import org.eclipse.core.commands.IHandler; - import org.eclipse.swt.SWT; import org.eclipse.swt.custom.BusyIndicator; import org.eclipse.swt.custom.StyleRange; @@ -57,6 +50,13 @@ import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Table; import org.eclipse.swt.widgets.TableItem; +import org.eclipse.core.commands.AbstractHandler; +import org.eclipse.core.commands.ExecutionEvent; +import org.eclipse.core.commands.ExecutionException; +import org.eclipse.core.commands.IHandler; + +import org.eclipse.core.runtime.Assert; + import org.eclipse.jface.bindings.keys.KeySequence; import org.eclipse.jface.bindings.keys.SWTKeySupport; import org.eclipse.jface.contentassist.IContentAssistSubjectControl; @@ -64,6 +64,9 @@ import org.eclipse.jface.internal.text.InformationControlReplacer; import org.eclipse.jface.internal.text.TableOwnerDrawSupport; import org.eclipse.jface.preference.JFacePreferences; import org.eclipse.jface.resource.JFaceResources; +import org.eclipse.jface.util.Geometry; +import org.eclipse.jface.viewers.StyledString; + import org.eclipse.jface.text.AbstractInformationControlManager; import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.DocumentEvent; @@ -78,8 +81,6 @@ import org.eclipse.jface.text.ITextViewer; import org.eclipse.jface.text.ITextViewerExtension; import org.eclipse.jface.text.TextUtilities; import org.eclipse.jface.text.AbstractInformationControlManager.Anchor; -import org.eclipse.jface.util.Geometry; -import org.eclipse.jface.viewers.StyledString; /** @@ -1772,7 +1773,7 @@ class CompletionProposalPopup implements IContentAssistListener { /** * Enables or disables showing of the caption line. See also {@link #setMessage(String)}. * - * @param show + * @param show <code>true</code> if the status line is visible * @since 3.2 */ public void setStatusLineVisible(boolean show) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistant.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistant.java index 119e48ab6fd..4b694dada4b 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistant.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistant.java @@ -748,18 +748,15 @@ public class ContentAssistant implements IContentAssistant, IContentAssistantExt break; } } - + /** - * Copied from org.eclipse.jface.window.Window. - * Returns the monitor whose client area contains the given point. If no - * monitor contains the point, returns the monitor that is closest to the - * point. If this is ever made public, it should be moved into a separate + * Copied from org.eclipse.jface.window.Window. Returns the monitor whose client area + * contains the given point. If no monitor contains the point, returns the monitor that is + * closest to the point. If this is ever made public, it should be moved into a separate * utility class. * - * @param toSearch - * point to find (display coordinates) - * @param rectangle - * rectangle to find (display coordinates) + * @param toSearch point to find (display coordinates) + * @param rectangle rectangle to find (display coordinates) * @return the monitor closest to the given point * @since 3.3 */ @@ -2079,8 +2076,8 @@ public class ContentAssistant implements IContentAssistant, IContentAssistantExt * <li>{@link ContentAssistant#STORE_SIZE_Y}</li> * </ul> * </p> - * - * @param dialogSettings + * + * @param dialogSettings the dialog settings * @since 3.0 */ public void setRestoreCompletionProposalSize(IDialogSettings dialogSettings) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatterExtension.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatterExtension.java index 9bfafa26787..6199c3e1852 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatterExtension.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatterExtension.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -49,29 +49,23 @@ public interface IContentFormatterExtension { /** * Formats the given region of the specified document. * <p> - * The formatter may safely assume that it is the only subject that - * modifies the document at this point in time. This method is fully - * reentrant, but not thread-safe. + * The formatter may safely assume that it is the only subject that modifies the document at + * this point in time. This method is fully reentrant, but not thread-safe. * <p> * The formatting process performed by <code>format(IDocument, IFormattingContext)</code> * happens as follows: * <ul> - * <li>In a first pass the content formatter formats the range of the - * document to be formatted by using the master formatting strategy. This - * happens regardless of the content type of the underlying partition. - * </li> - * <li>In the second pass, the range is formatted again, this time using - * the registered slave formatting strategies. For each partition contained - * in the range to be formatted, the content formatter determines its - * content type and formats the partition with the correct formatting - * strategy. - * </li> - * - * @param document - * The document to be formatted - * @param context - * The formatting context to pass to the formatting strategies. - * This argument must not be <code>null</code>. + * <li>In a first pass the content formatter formats the range of the document to be formatted + * by using the master formatting strategy. This happens regardless of the content type of the + * underlying partition.</li> + * <li>In the second pass, the range is formatted again, this time using the registered slave + * formatting strategies. For each partition contained in the range to be formatted, the content + * formatter determines its content type and formats the partition with the correct formatting + * strategy.</li> + * + * @param document the document to be formatted + * @param context the formatting context to pass to the formatting strategies. This argument + * must not be <code>null</code>. */ void format(IDocument document, IFormattingContext context); } diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingContext.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingContext.java index 82a1e51fb34..2b35dce5b7e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingContext.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingContext.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -18,7 +18,7 @@ import org.eclipse.jface.preference.IPreferenceStore; /** * Formatting context used in formatting strategies implementing interface * <code>IFormattingStrategyExtension</code>. - * + * * @see IFormattingStrategyExtension * @since 3.0 */ @@ -27,130 +27,111 @@ public interface IFormattingContext { /** * Dispose of the formatting context. * <p> - * Must be called after the formatting context has been used in a - * formatting process. + * Must be called after the formatting context has been used in a formatting process. */ void dispose(); /** - * Returns the preference keys used for the retrieval of formatting - * preferences. - * + * Returns the preference keys used for the retrieval of formatting preferences. + * * @return The preference keys for formatting */ String[] getPreferenceKeys(); /** * Retrieves the property <code>key</code> from the formatting context - * - * @param key - * Key of the property to store in the context - * @return The property <code>key</code> if available, <code>null</code> - * otherwise + * + * @param key the key of the property to store in the context + * @return the property <code>key</code> if available, <code>null</code> otherwise */ Object getProperty(Object key); /** * Is this preference key for a boolean preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for a boolean preference, - * <code>false</code> otherwise. + * + * @param key the preference key to query its type + * @return <code>true</code> iff this key is for a boolean preference, <code>false</code> + * otherwise. */ boolean isBooleanPreference(String key); /** * Is this preference key for a double preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for a double preference, - * <code>false</code> otherwise. + * + * @param key the preference key to query its type + * @return <code>true</code> iff this key is for a double preference, <code>false</code> + * otherwise. */ boolean isDoublePreference(String key); /** * Is this preference key for a float preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for a float preference, - * <code>false</code> otherwise. + * + * @param key The preference key to query its type + * @return <code>true</code> iff this key is for a float preference, <code>false</code> + * otherwise. */ boolean isFloatPreference(String key); /** * Is this preference key for an integer preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for an integer preference, - * <code>false</code> otherwise. + * + * @param key The preference key to query its type + * @return <code>true</code> iff this key is for an integer preference, <code>false</code> + * otherwise. */ boolean isIntegerPreference(String key); /** * Is this preference key for a long preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for a long preference, - * <code>false</code> otherwise. + * + * @param key The preference key to query its type + * @return <code>true</code> iff this key is for a long preference, <code>false</code> + * otherwise. */ boolean isLongPreference(String key); /** * Is this preference key for a string preference? - * - * @param key - * The preference key to query its type - * @return <code>true</code> iff this key is for a string preference, - * <code>false</code> otherwise. + * + * @param key The preference key to query its type + * @return <code>true</code> iff this key is for a string preference, <code>false</code> + * otherwise. */ boolean isStringPreference(String key); /** * Stores the preferences from a map to a preference store. * <p> - * Note that the preference keys returned by - * {@link #getPreferenceKeys()} must not be used in the preference store. - * Otherwise the preferences are overwritten. + * Note that the preference keys returned by {@link #getPreferenceKeys()} must not be used in + * the preference store. Otherwise the preferences are overwritten. * </p> - * - * @param map - * Map to retrieve the preferences from - * @param store - * Preference store to store the preferences in + * + * @param map Map to retrieve the preferences from + * @param store Preference store to store the preferences in */ void mapToStore(Map map, IPreferenceStore store); /** * Stores the property <code>key</code> in the formatting context. - * - * @param key - * Key of the property to store in the context - * @param property - * Property to store in the context. If already present, the new - * property overwrites the present one. + * + * @param key Key of the property to store in the context + * @param property Property to store in the context. If already present, the new property + * overwrites the present one. */ void setProperty(Object key, Object property); /** * Retrieves the preferences from a preference store in a map. * <p> - * Note that the preference keys returned by - * {@link #getPreferenceKeys()} must not be used in the map. Otherwise the - * preferences are overwritten. + * Note that the preference keys returned by {@link #getPreferenceKeys()} must not be used in + * the map. Otherwise the preferences are overwritten. * </p> - * - * @param store - * Preference store to retrieve the preferences from - * @param map - * Map to store the preferences in - * @param useDefault - * <code>true</code> if the default preferences should be - * used, <code>false</code> otherwise + * + * @param store Preference store to retrieve the preferences from + * @param map Map to store the preferences in + * @param useDefault <code>true</code> if the default preferences should be used, + * <code>false</code> otherwise */ void storeToMap(IPreferenceStore store, Map map, boolean useDefault); } diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategyExtension.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategyExtension.java index 91e275b0af2..06f97a5dbbf 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategyExtension.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategyExtension.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -44,12 +44,9 @@ public interface IFormattingStrategyExtension { void format(); /** - * Informs the strategy about the start of a formatting process in which it - * will participate. - * - * @param context - * Formatting context used in the corresponding formatting - * process. + * Informs the strategy about the start of a formatting process in which it will participate. + * + * @param context the formatting context used in the corresponding formatting process. */ void formatterStarts(IFormattingContext context); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/HyperlinkManager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/HyperlinkManager.java index 7d64f27c3ff..69cc889de8d 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/HyperlinkManager.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/HyperlinkManager.java @@ -298,10 +298,9 @@ public class HyperlinkManager implements ITextListener, Listener, KeyListener, M } /** - * Computes the length of the longest detected - * hyperlink. + * Computes the length of the longest detected hyperlink. * - * @param hyperlinks + * @param hyperlinks the list of hyperlinks * @return the length of the longest detected */ protected int computeLongestHyperlinkLength(List hyperlinks) { @@ -472,11 +471,11 @@ public class HyperlinkManager implements ITextListener, Listener, KeyListener, M fHyperlinkPresenter.showHyperlinks(fActiveHyperlinks); } - + /** * Checks whether the given state mask is registered. * - * @param stateMask + * @param stateMask the state mask * @return <code>true</code> if a detector is registered for the given state mask * @since 3.3 */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/MultipleHyperlinkPresenter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/MultipleHyperlinkPresenter.java index e3f23343ce7..062057b032f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/MultipleHyperlinkPresenter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/MultipleHyperlinkPresenter.java @@ -320,10 +320,11 @@ public class MultipleHyperlinkPresenter extends DefaultHyperlinkPresenter { } private class MultipleHyperlinkHover implements ITextHover, ITextHoverExtension, ITextHoverExtension2 { - + /** * @see org.eclipse.jface.text.ITextHover#getHoverInfo(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion) - * @deprecated + * @deprecated As of 3.4, replaced by + * {@link ITextHoverExtension2#getHoverInfo2(ITextViewer, IRegion)} */ public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) { return null; diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/URLHyperlink.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/URLHyperlink.java index bc794c6d6fe..063e8e11384 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/URLHyperlink.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/URLHyperlink.java @@ -31,9 +31,9 @@ public class URLHyperlink implements IHyperlink { /** * Creates a new URL hyperlink. - * - * @param region - * @param urlString + * + * @param region the region + * @param urlString the URL string */ public URLHyperlink(IRegion region, String urlString) { Assert.isNotNull(urlString); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedModeUI.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedModeUI.java index 399dd41463a..42897d7943e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedModeUI.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedModeUI.java @@ -1051,7 +1051,7 @@ public class LinkedModeUI { * * @param document the document * @return all possible content types of <code>document</code> - * @throws BadPartitioningException + * @throws BadPartitioningException if partitioning is invalid for this document * @since 3.1 */ private String[] getContentTypes(IDocument document) throws BadPartitioningException { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedPositionAnnotations.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedPositionAnnotations.java index d82f1bb3a0b..6a6d9d8de2f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedPositionAnnotations.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/link/LinkedPositionAnnotations.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -22,9 +22,6 @@ import org.eclipse.core.runtime.Assert; import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.Position; -import org.eclipse.jface.text.link.LinkedModeModel; -import org.eclipse.jface.text.link.LinkedPosition; -import org.eclipse.jface.text.link.LinkedPositionGroup; import org.eclipse.jface.text.source.Annotation; import org.eclipse.jface.text.source.AnnotationModel; @@ -162,12 +159,11 @@ final class LinkedPositionAnnotations extends AnnotationModel { /** * Switches the focus position to <code>position</code> given the - * <code>LinkedModeModel env</code>. The slave positions for <code>position</code> - * is extracted from the environment and set accordingly, the target positions - * are updated as well. - * - * @param env - * @param position + * <code>LinkedModeModel env</code>. The slave positions for <code>position</code> is extracted + * from the environment and set accordingly, the target positions are updated as well. + * + * @param env the linked mode model + * @param position the linked position */ public void switchToPosition(LinkedModeModel env, LinkedPosition position) { if (fDocument == null || @@ -238,8 +234,9 @@ final class LinkedPositionAnnotations extends AnnotationModel { } /** - * Sets the target positions - * @param positions + * Sets the target positions. + * + * @param positions an array of positions */ public void setTargets(Position[] positions) { fTargets= positions; diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationColumn.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationColumn.java index f090dc00c63..17306ae2459 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationColumn.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationColumn.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,16 +13,20 @@ package org.eclipse.jface.text.source; /** - * @deprecated use {@link org.eclipse.jface.text.source.AnnotationRulerColumn} instead. + * @deprecated use + * {@link org.eclipse.jface.text.source.AnnotationRulerColumn#AnnotationRulerColumn(int)} + * instead. * @since 2.0 */ public final class AnnotationColumn extends AnnotationRulerColumn { /** * Creates a new <code>AnnotationColumn</code> of the given width. - * + * * @param width the width of this column - * @deprecated + * @deprecated Use + * {@link org.eclipse.jface.text.source.AnnotationRulerColumn#AnnotationRulerColumn(int)} + * instead */ public AnnotationColumn(int width) { super(width); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java index 17526fd5e2e..59acd9ac45f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java @@ -535,8 +535,8 @@ public class CompositeRuler implements IVerticalRuler, IVerticalRulerExtension, /** * Constructs a new composite ruler with the given gap between its columns. - * - * @param gap + * + * @param gap the gap */ public CompositeRuler(int gap) { fGap= gap; diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/DefaultCharacterPairMatcher.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/DefaultCharacterPairMatcher.java index 9c1f904ca2b..4d6c2e33c8c 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/DefaultCharacterPairMatcher.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/DefaultCharacterPairMatcher.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2007 IBM Corporation and others. + * Copyright (c) 2006, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -116,7 +116,7 @@ public class DefaultCharacterPairMatcher implements ICharacterPairMatcher { * @param boundary a boundary at which the search should stop * @param startPos the start offset * @return the index of the end character if it was found, otherwise -1 - * @throws BadLocationException + * @throws BadLocationException if the document is accessed with invalid offset or line */ private int findMatchingPeer(DocumentPartitionAccessor doc, char start, char end, boolean searchForward, int boundary, int startPos) throws BadLocationException { int pos= startPos; @@ -172,28 +172,27 @@ public class DefaultCharacterPairMatcher implements ICharacterPairMatcher { fPartitioning= partitioning; fPartition= partition; } - + /** * Returns the character at the specified position in this document. * * @param pos an offset within this document * @return the character at the offset - * @throws BadLocationException + * @throws BadLocationException if the offset is invalid in this document */ public char getChar(int pos) throws BadLocationException { return fDocument.getChar(pos); } - + /** - * Returns true if the character at the specified position is a - * valid match for the specified end character. To be a valid - * match, it must be in the appropriate partition and equal to the - * end character. + * Returns true if the character at the specified position is a valid match for the + * specified end character. To be a valid match, it must be in the appropriate partition and + * equal to the end character. * * @param pos an offset within this document * @param end the end character to match against * @return true exactly if the position represents a valid match - * @throws BadLocationException + * @throws BadLocationException if the offset is invalid in this document */ public boolean isMatch(int pos, char end) throws BadLocationException { return getChar(pos) == end && inPartition(pos); diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineNumberRulerColumn.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineNumberRulerColumn.java index d850b114177..8cb5cb7d9ba 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineNumberRulerColumn.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineNumberRulerColumn.java @@ -873,14 +873,16 @@ public class LineNumberRulerColumn implements IVerticalRulerColumn { protected CompositeRuler getParentRuler() { return fParentRuler; } - - + + /** * Returns the number of lines in the view port. * - * @param textWidget - * @return the number of lines visible in the view port <code>-1</code> if there's no client area - * @deprecated this method should not be used - it relies on the widget using a uniform line height + * @param textWidget the styled text widget + * @return the number of lines visible in the view port <code>-1</code> if there's no client + * area + * @deprecated this method should not be used - it relies on the widget using a uniform line + * height */ static int getVisibleLinesInViewport(StyledText textWidget) { if (textWidget != null) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java index 5e5730e8d37..39409af55a5 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -58,13 +58,12 @@ public final class MatchingCharacterPainter implements IPainter, PaintListener { /** - * Creates a new MatchingCharacterPainter for the given source viewer using - * the given character pair matcher. The character matcher is not adopted by - * this painter. Thus, it is not disposed. However, this painter requires - * exclusive access to the given pair matcher. - * - * @param sourceViewer - * @param matcher + * Creates a new MatchingCharacterPainter for the given source viewer using the given character + * pair matcher. The character matcher is not adopted by this painter. Thus, it is not disposed. + * However, this painter requires exclusive access to the given pair matcher. + * + * @param sourceViewer the source viewer + * @param matcher the character pair matcher */ public MatchingCharacterPainter(ISourceViewer sourceViewer, ICharacterPairMatcher matcher) { fSourceViewer= sourceViewer; diff --git a/org.eclipse.search.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.search.tests/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..bcbdd060b4a 100644 --- a/org.eclipse.search.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.search.tests/.settings/org.eclipse.jdt.core.prefs @@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.search/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.search/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..bcbdd060b4a 100644 --- a/org.eclipse.search/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.search/.settings/org.eclipse.jdt.core.prefs @@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.text.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.text.tests/.settings/org.eclipse.jdt.core.prefs index b446c773f1c..787aa457c53 100644 --- a/org.eclipse.text.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.text.tests/.settings/org.eclipse.jdt.core.prefs @@ -56,6 +56,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
diff --git a/org.eclipse.text/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.text/.settings/org.eclipse.jdt.core.prefs index 0f6ae0d0dc6..2c48ea20b87 100644 --- a/org.eclipse.text/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.text/.settings/org.eclipse.jdt.core.prefs @@ -1,4 +1,4 @@ -#Wed Jul 16 14:44:09 CEST 2008
+#Tue Aug 26 14:45:32 CEST 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.builder.cleanOutputFolder=clean
org.eclipse.jdt.core.builder.duplicateResourceTask=warning
@@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/CopyOnWriteTextStore.java b/org.eclipse.text/src/org/eclipse/jface/text/CopyOnWriteTextStore.java index 375b074c445..fd5f3584000 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/CopyOnWriteTextStore.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/CopyOnWriteTextStore.java @@ -16,22 +16,23 @@ import org.eclipse.core.runtime.Assert; /** * Copy-on-write <code>ITextStore</code> wrapper. * <p> - * This implementation uses an unmodifiable text store for the initial content. - * Upon first modification attempt, the unmodifiable store is replaced with - * a modifiable instance which must be supplied in the constructor.</p> + * This implementation uses an unmodifiable text store for the initial content. Upon first + * modification attempt, the unmodifiable store is replaced with a modifiable instance which must be + * supplied in the constructor. + * </p> * <p> * This class is not intended to be subclassed. * </p> - * + * * @since 3.2 * @noextend This class is not intended to be subclassed by clients. */ public class CopyOnWriteTextStore implements ITextStore { /** - * An unmodifiable String based text store. It is not possible to modify the content - * other than using {@link #set}. Trying to {@link #replace} a text range will - * throw an <code>UnsupportedOperationException</code>. + * An unmodifiable String based text store. It is not possible to modify the content other than + * using {@link #set}. Trying to {@link #replace} a text range will throw an + * <code>UnsupportedOperationException</code>. */ private static class StringTextStore implements ITextStore { @@ -47,7 +48,8 @@ public class CopyOnWriteTextStore implements ITextStore { /** * Create a text store with initial content. - * @param text the initial content + * + * @param text the initial content */ private StringTextStore(String text) { super(); @@ -99,11 +101,10 @@ public class CopyOnWriteTextStore implements ITextStore { private final ITextStore fModifiableTextStore; /** - * Creates an empty text store. The given text store will be used upon first - * modification attempt. + * Creates an empty text store. The given text store will be used upon first modification + * attempt. * - * @param modifiableTextStore - * a modifiable <code>ITextStore</code> instance, may not be + * @param modifiableTextStore a modifiable <code>ITextStore</code> instance, may not be * <code>null</code> */ public CopyOnWriteTextStore(ITextStore modifiableTextStore) { diff --git a/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java b/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java index 7f49ee60d31..73ff0a1b7c7 100755 --- a/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java @@ -165,12 +165,12 @@ abstract class TreeLineTracker implements ILineTracker { */ protected TreeLineTracker() { } - + /** * Package visible constructor for creating a tree tracker from a list tracker. * - * @param tracker - */ + * @param tracker the list line tracker + */ TreeLineTracker(ListLineTracker tracker) { final List lines= tracker.getLines(); final int n= lines.size(); diff --git a/org.eclipse.text/src/org/eclipse/jface/text/link/LinkedModeManager.java b/org.eclipse.text/src/org/eclipse/jface/text/link/LinkedModeManager.java index dc8805c5738..d8a3c9502aa 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/link/LinkedModeManager.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/link/LinkedModeManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -143,9 +143,9 @@ class LinkedModeManager { /** * Notify the manager about a leaving model. - * - * @param model - * @param flags + * + * @param model the model to nest + * @param flags the reason and commands for leaving linked mode */ private void left(LinkedModeModel model, int flags) { if (!fEnvironments.contains(model)) diff --git a/org.eclipse.text/src/org/eclipse/text/undo/DocumentUndoManager.java b/org.eclipse.text/src/org/eclipse/text/undo/DocumentUndoManager.java index a9594961324..dd14f412a65 100644 --- a/org.eclipse.text/src/org/eclipse/text/undo/DocumentUndoManager.java +++ b/org.eclipse.text/src/org/eclipse/text/undo/DocumentUndoManager.java @@ -437,8 +437,7 @@ public class DocumentUndoManager implements IDocumentUndoManager { /** * Creates a new compound text change. * - * @param manager - * the undo manager for this change + * @param manager the undo manager for this change */ UndoableCompoundTextChange(DocumentUndoManager manager) { super(manager); @@ -951,11 +950,9 @@ public class DocumentUndoManager implements IDocumentUndoManager { } /** - * Adds the given text edit to the operation history if it is not part of a - * compound change. + * Adds the given text edit to the operation history if it is not part of a compound change. * - * @param edit - * the edit to be added + * @param edit the edit to be added */ private void addToOperationHistory(UndoableTextChange edit) { if (!fFoldingIntoCompoundChange diff --git a/org.eclipse.ui.editors.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.ui.editors.tests/.settings/org.eclipse.jdt.core.prefs index b446c773f1c..787aa457c53 100644 --- a/org.eclipse.ui.editors.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.ui.editors.tests/.settings/org.eclipse.jdt.core.prefs @@ -56,6 +56,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
diff --git a/org.eclipse.ui.editors/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.ui.editors/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..ac141dd3032 100644 --- a/org.eclipse.ui.editors/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.ui.editors/.settings/org.eclipse.jdt.core.prefs @@ -1,4 +1,4 @@ -#Tue Jul 15 15:50:55 CEST 2008
+#Tue Aug 26 14:47:31 CEST 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.builder.cleanOutputFolder=clean
org.eclipse.jdt.core.builder.duplicateResourceTask=warning
@@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileBufferOperationAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileBufferOperationAction.java index 6ffe2de39a5..3094f66fa02 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileBufferOperationAction.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileBufferOperationAction.java @@ -223,7 +223,7 @@ public class FileBufferOperationAction extends Action implements IWorkbenchWindo /** * Tells whether this action accepts the given location. * - * @param location + * @param location the location * @return <code>true</code> if the given location is acceptable */ protected boolean isAcceptableLocation(IPath location) { diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java index c61b193b68d..a0d3732052a 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java @@ -72,6 +72,7 @@ import org.eclipse.ui.PlatformUI; import org.eclipse.ui.internal.editors.text.NLSUtility; import org.eclipse.ui.internal.editors.text.WorkspaceOperationRunner; import org.eclipse.ui.part.FileEditorInput; + import org.eclipse.ui.texteditor.AbstractMarkerAnnotationModel; import org.eclipse.ui.texteditor.ResourceMarkerAnnotationModel; @@ -975,8 +976,8 @@ public class FileDocumentProvider extends StorageDocumentProvider { /** * Refreshes the given file resource. - * - * @param file + * + * @param file the file * @throws CoreException if the refresh fails * @since 2.1 */ diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextFileDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextFileDocumentProvider.java index 4969d76bde0..83df3da97fc 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextFileDocumentProvider.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextFileDocumentProvider.java @@ -72,6 +72,7 @@ import org.eclipse.ui.internal.editors.text.UISynchronizationContext; import org.eclipse.ui.internal.editors.text.WorkspaceOperationRunner; import org.eclipse.ui.keys.IBindingService; import org.eclipse.ui.part.FileEditorInput; + import org.eclipse.ui.texteditor.AbstractMarkerAnnotationModel; import org.eclipse.ui.texteditor.IDocumentProvider; import org.eclipse.ui.texteditor.IDocumentProviderExtension; @@ -116,9 +117,9 @@ public class TextFileDocumentProvider implements IDocumentProvider, IDocumentPro /** * The actual functionality of this operation. - * + * * @param monitor the progress monitor - * @throws CoreException + * @throws CoreException if the execution fails */ protected abstract void execute(IProgressMonitor monitor) throws CoreException; diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/quickdiff/QuickDiffRestoreAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/quickdiff/QuickDiffRestoreAction.java index e8972347268..a5de39761e2 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/quickdiff/QuickDiffRestoreAction.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/quickdiff/QuickDiffRestoreAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -27,6 +27,7 @@ import org.eclipse.jface.text.source.ILineDiffer; import org.eclipse.jface.text.source.IVerticalRulerInfo; import org.eclipse.ui.IEditorInput; + import org.eclipse.ui.texteditor.IDocumentProvider; import org.eclipse.ui.texteditor.IEditorStatusLine; import org.eclipse.ui.texteditor.ITextEditor; @@ -152,8 +153,8 @@ public abstract class QuickDiffRestoreAction extends TextEditorAction implements /** * Returns the active line - * - * @param useRulerInfo + * + * @param useRulerInfo <code>true</code> if the ruler info should be used * @return the line of interest. * @since 3.1 */ diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/LinkedModeConfigurationBlock.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/LinkedModeConfigurationBlock.java index 84df80df9fe..f1bdb144ec8 100755 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/LinkedModeConfigurationBlock.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/LinkedModeConfigurationBlock.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -55,11 +55,11 @@ import org.eclipse.jface.viewers.TableViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.viewers.ViewerComparator; -import org.eclipse.ui.editors.text.EditorsUI; - import org.eclipse.ui.texteditor.AnnotationPreference; import org.eclipse.ui.texteditor.MarkerAnnotationPreferences; +import org.eclipse.ui.editors.text.EditorsUI; + /** * Configures the linked mode preferences. The preferences belong to * org.eclipse.ui.editors. However, as they are chiefly used in the java editor, @@ -370,22 +370,19 @@ class LinkedModeConfigurationBlock implements IPreferenceConfigurationBlock { */ public void applyData(Object data) { } - + /** - * Returns the number of pixels corresponding to the width of the given - * number of characters. - * <p> - * This method may only be called after <code>initializeDialogUnits</code> - * has been called. - * </p> - * <p> - * Clients may call this framework method, but should not override it. - * </p> - * - * @param chars - * the number of characters - * @return the number of pixels - */ + * Returns the number of pixels corresponding to the width of the given number of characters. + * <p> + * This method may only be called after <code>initializeDialogUnits</code> has been called. + * </p> + * <p> + * Clients may call this framework method, but should not override it. + * </p> + * + * @param chars the number of characters + * @return the number of pixels + */ protected int convertWidthInCharsToPixels(int chars) { // test for failure to initialize for backward compatibility if (fFontMetrics == null) @@ -394,37 +391,33 @@ class LinkedModeConfigurationBlock implements IPreferenceConfigurationBlock { } /** - * Returns the number of pixels corresponding to the height of the given - * number of characters. - * <p> - * This method may only be called after <code>initializeDialogUnits</code> - * has been called. - * </p> - * <p> - * Clients may call this framework method, but should not override it. - * </p> - * - * @param chars - * the number of characters - * @return the number of pixels - */ + * Returns the number of pixels corresponding to the height of the given number of characters. + * <p> + * This method may only be called after <code>initializeDialogUnits</code> has been called. + * </p> + * <p> + * Clients may call this framework method, but should not override it. + * </p> + * + * @param chars the number of characters + * @return the number of pixels + */ protected int convertHeightInCharsToPixels(int chars) { // test for failure to initialize for backward compatibility if (fFontMetrics == null) return 0; return Dialog.convertHeightInCharsToPixels(fFontMetrics, chars); } + /** - * Initializes the computation of horizontal and vertical dialog units based - * on the size of current font. - * <p> - * This method must be called before any of the dialog unit based conversion - * methods are called. - * </p> - * - * @param testControl - * a control from which to obtain the current font - */ + * Initializes the computation of horizontal and vertical dialog units based on the size of + * current font. + * <p> + * This method must be called before any of the dialog unit based conversion methods are called. + * </p> + * + * @param testControl a control from which to obtain the current font + */ protected void initializeDialogUnits(Control testControl) { // Compute and store a font metric GC gc = new GC(testControl); diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/OverlayPreferenceStore.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/OverlayPreferenceStore.java index 3cbc984a108..4de30d45b5e 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/OverlayPreferenceStore.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/OverlayPreferenceStore.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -523,8 +523,8 @@ class OverlayPreferenceStore implements IPreferenceStore { * <p> * Note: This method must be called before {@link #load()} is called. * </p> - * - * @param keys + * + * @param keys an array with overlay keys * @since 3.0 */ public void addKeys(OverlayKey[] keys) { diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SelectResourcesBlock.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SelectResourcesBlock.java index 665e370355d..65158a10f2a 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SelectResourcesBlock.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SelectResourcesBlock.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -45,10 +45,10 @@ import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.TreeExpansionEvent; import org.eclipse.jface.viewers.ViewerComparator; -/* +/* * XXX: This is an copy of the internal ResourceTreeAndListGroup class, see: * https://bugs.eclipse.org/bugs/show_bug.cgi?id=147027 - */ + */ /** * Workbench-level composite that combines a CheckboxTreeViewer and @@ -103,17 +103,17 @@ class SelectResourcesBlock implements ICheckStateListener, ISelectionChangedList private static int PREFERRED_HEIGHT= 150; /** - * Create an instance of this class. Use this constructor if you wish to - * specify the width and/or height of the combined widget (to only hard code - * one of the sizing dimensions, specify the other dimension's value as -1) - * - * @param parent - * @param rootObject - * @param treeContentProvider - * @param treeLabelProvider - * @param listContentProvider - * @param listLabelProvider - * @param style + * Create an instance of this class. Use this constructor if you wish to specify the width + * and/or height of the combined widget (to only hard code one of the sizing dimensions, specify + * the other dimension's value as -1) + * + * @param parent the parent composite + * @param rootObject the root object + * @param treeContentProvider the tree content provider + * @param treeLabelProvider the tree label provider + * @param listContentProvider the list content provider + * @param listLabelProvider the list label provider + * @param style the style flags for the new Composite * @param useHeightHint If true then use the height hint to make this group big enough */ public SelectResourcesBlock(Composite parent, Object rootObject, ITreeContentProvider treeContentProvider, ILabelProvider treeLabelProvider, IStructuredContentProvider listContentProvider, ILabelProvider listLabelProvider, int style, boolean useHeightHint) { diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SpellingConfigurationBlock.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SpellingConfigurationBlock.java index d42568df4c7..4e6e9d29ddb 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SpellingConfigurationBlock.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/SpellingConfigurationBlock.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -50,13 +50,13 @@ import org.eclipse.jface.viewers.SelectionChangedEvent; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.Viewer; -import org.eclipse.ui.editors.text.EditorsUI; - import org.eclipse.ui.texteditor.spelling.IPreferenceStatusMonitor; import org.eclipse.ui.texteditor.spelling.ISpellingPreferenceBlock; import org.eclipse.ui.texteditor.spelling.SpellingEngineDescriptor; import org.eclipse.ui.texteditor.spelling.SpellingService; +import org.eclipse.ui.editors.text.EditorsUI; + /** * Configures spelling preferences. * @@ -154,10 +154,9 @@ class SpellingConfigurationBlock implements IPreferenceConfigurationBlock { private IStatus fStatus; /** - * Initializes with the given status monitor to which status - * changes are forwarded. - * - * @param forwardedMonitor + * Initializes with the given status monitor to which status changes are forwarded. + * + * @param forwardedMonitor the status monitor to which changes are forwarded */ public ForwardingStatusMonitor(IPreferenceStatusMonitor forwardedMonitor) { fForwardedMonitor= forwardedMonitor; diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/URLHyperlink.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/URLHyperlink.java index 83a12faa884..e2df401fa7e 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/URLHyperlink.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/URLHyperlink.java @@ -27,13 +27,13 @@ import org.eclipse.ui.browser.IWorkbenchBrowserSupport; * @since 3.1 */ final class URLHyperlink extends org.eclipse.jface.text.hyperlink.URLHyperlink { - - + + /** * Creates a new URL hyperlink. - * - * @param region - * @param urlString + * + * @param region the region + * @param urlString the URL string */ public URLHyperlink(IRegion region, String urlString) { super(region, urlString); diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java index ac79fa8bd77..4abd8098d4d 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java @@ -10,12 +10,31 @@ *******************************************************************************/ package org.eclipse.ui.texteditor; -import com.ibm.icu.text.MessageFormat; - import java.io.File; import java.util.Iterator; import java.util.List; +import com.ibm.icu.text.MessageFormat; + +import org.eclipse.swt.SWT; +import org.eclipse.swt.custom.StyledTextPrintOptions; +import org.eclipse.swt.graphics.Color; +import org.eclipse.swt.graphics.Point; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Display; +import org.eclipse.swt.widgets.FileDialog; +import org.eclipse.swt.widgets.Menu; +import org.eclipse.swt.widgets.Shell; + +import org.eclipse.core.commands.operations.IOperationApprover; +import org.eclipse.core.commands.operations.IUndoContext; +import org.eclipse.core.filesystem.EFS; +import org.eclipse.core.filesystem.IFileStore; +import org.eclipse.core.filesystem.URIUtil; + import org.eclipse.core.runtime.Assert; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IPath; @@ -30,26 +49,8 @@ import org.eclipse.core.resources.IWorkspace; import org.eclipse.core.resources.IWorkspaceRoot; import org.eclipse.core.resources.ResourcesPlugin; -import org.eclipse.core.commands.operations.IOperationApprover; -import org.eclipse.core.commands.operations.IUndoContext; import org.eclipse.core.filebuffers.FileBuffers; import org.eclipse.core.filebuffers.IFileBufferStatusCodes; -import org.eclipse.core.filesystem.EFS; -import org.eclipse.core.filesystem.IFileStore; -import org.eclipse.core.filesystem.URIUtil; - -import org.eclipse.swt.SWT; -import org.eclipse.swt.custom.StyledTextPrintOptions; -import org.eclipse.swt.graphics.Color; -import org.eclipse.swt.graphics.Point; -import org.eclipse.swt.layout.GridData; -import org.eclipse.swt.layout.GridLayout; -import org.eclipse.swt.widgets.Composite; -import org.eclipse.swt.widgets.Control; -import org.eclipse.swt.widgets.Display; -import org.eclipse.swt.widgets.FileDialog; -import org.eclipse.swt.widgets.Menu; -import org.eclipse.swt.widgets.Shell; import org.eclipse.jface.action.Action; import org.eclipse.jface.action.GroupMarker; @@ -63,6 +64,11 @@ import org.eclipse.jface.dialogs.IMessageProvider; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.dialogs.MessageDialogWithToggle; import org.eclipse.jface.preference.IPreferenceStore; +import org.eclipse.jface.util.PropertyChangeEvent; +import org.eclipse.jface.viewers.ISelection; +import org.eclipse.jface.viewers.ISelectionProvider; +import org.eclipse.jface.window.Window; + import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.ITextViewerExtension6; @@ -94,10 +100,6 @@ import org.eclipse.jface.text.source.LineNumberChangeRulerColumn; import org.eclipse.jface.text.source.LineNumberRulerColumn; import org.eclipse.jface.text.source.OverviewRuler; import org.eclipse.jface.text.source.SourceViewer; -import org.eclipse.jface.util.PropertyChangeEvent; -import org.eclipse.jface.viewers.ISelection; -import org.eclipse.jface.viewers.ISelectionProvider; -import org.eclipse.jface.window.Window; import org.eclipse.ui.IEditorInput; import org.eclipse.ui.IFileEditorInput; @@ -108,11 +110,6 @@ import org.eclipse.ui.PlatformUI; import org.eclipse.ui.actions.ContributionItemFactory; import org.eclipse.ui.dialogs.PreferencesUtil; import org.eclipse.ui.dialogs.SaveAsDialog; -import org.eclipse.ui.editors.text.DefaultEncodingSupport; -import org.eclipse.ui.editors.text.EditorsUI; -import org.eclipse.ui.editors.text.ForwardingDocumentProvider; -import org.eclipse.ui.editors.text.IEncodingSupport; -import org.eclipse.ui.editors.text.ITextEditorHelpContextIds; import org.eclipse.ui.ide.FileStoreEditorInput; import org.eclipse.ui.ide.IDEActionFactory; import org.eclipse.ui.ide.IGotoMarker; @@ -133,12 +130,19 @@ import org.eclipse.ui.operations.NonLocalUndoUserApprover; import org.eclipse.ui.part.FileEditorInput; import org.eclipse.ui.part.IShowInSource; import org.eclipse.ui.part.ShowInContext; +import org.eclipse.ui.views.markers.MarkerViewUtil; + import org.eclipse.ui.texteditor.rulers.IColumnSupport; import org.eclipse.ui.texteditor.rulers.IContributedRulerColumn; import org.eclipse.ui.texteditor.rulers.RulerColumnDescriptor; import org.eclipse.ui.texteditor.rulers.RulerColumnPreferenceAdapter; import org.eclipse.ui.texteditor.rulers.RulerColumnRegistry; -import org.eclipse.ui.views.markers.MarkerViewUtil; + +import org.eclipse.ui.editors.text.DefaultEncodingSupport; +import org.eclipse.ui.editors.text.EditorsUI; +import org.eclipse.ui.editors.text.ForwardingDocumentProvider; +import org.eclipse.ui.editors.text.IEncodingSupport; +import org.eclipse.ui.editors.text.ITextEditorHelpContextIds; /** * An intermediate editor comprising functionality not present in the leaner <code>AbstractTextEditor</code>, @@ -1839,15 +1843,15 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor { updateMarkerViews(annotation); return annotation; } - + /** * Updates visible views that show markers. * <p> - * If the given annotation can be associated with a marker then - * this method tries select the this marker in views that show - * markers. + * If the given annotation can be associated with a marker then this method tries select the + * this marker in views that show markers. * </p> - * @param annotation + * + * @param annotation the annotation * @since 3.2 */ protected void updateMarkerViews(Annotation annotation) { diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java index 9ece1101ab4..ab3bf90338e 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java @@ -126,9 +126,10 @@ public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnota /** * Returns a new default marker annotation access with the given preferences. - * - * @param markerAnnotationPreferences - * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess#DefaultMarkerAnnotationAccess()} + * + * @param markerAnnotationPreferences the marker annotation preference + * @deprecated As of 3.0, replaced by + * {@link org.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess#DefaultMarkerAnnotationAccess()} */ public DefaultMarkerAnnotationAccess(MarkerAnnotationPreferences markerAnnotationPreferences) { fMarkerAnnotationPreferences= markerAnnotationPreferences; diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MessageRegion.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MessageRegion.java index ec80c02d5a2..7369f13d6ac 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MessageRegion.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MessageRegion.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -58,9 +58,8 @@ class MessageRegion { /** * Create the contents for the receiver. - * - * @param parent - * the Composite that the children will be created in + * + * @param parent the Composite that the children will be created in */ public void createContents(Composite parent) { messageComposite = new Composite(parent, SWT.NONE); @@ -96,25 +95,22 @@ class MessageRegion { } /** - * Set the layoutData for the messageArea. In most cases this will be a copy - * of the layoutData used in setTitleLayoutData. - * - * @param layoutData - * the layoutData for the message area composite. + * Set the layoutData for the messageArea. In most cases this will be a copy of the layoutData + * used in setTitleLayoutData. + * + * @param layoutData the layoutData for the message area composite. */ public void setMessageLayoutData(Object layoutData) { messageComposite.setLayoutData(layoutData); } /** - * Show the new message in the message text and update the image. Base the - * background color on whether or not there are errors. - * - * @param newMessage - * The new value for the message - * @param newType - * One of the IMessageProvider constants. If newType is - * IMessageProvider.NONE show the title. + * Show the new message in the message text and update the image. Base the background color on + * whether or not there are errors. + * + * @param newMessage The new value for the message + * @param newType One of the IMessageProvider constants. If newType is IMessageProvider.NONE + * show the title. * @see IMessageProvider */ public void updateText(String newMessage, int newType) { @@ -174,9 +170,8 @@ class MessageRegion { /** * Set the colors of the message area. - * - * @param color - * The color to be use in the message area. + * + * @param color the color to be use in the message area. */ private void setMessageColors(Color color) { messageText.setBackground(color); diff --git a/org.eclipse.ui.examples.javaeditor/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.ui.examples.javaeditor/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..bcbdd060b4a 100644 --- a/org.eclipse.ui.examples.javaeditor/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.ui.examples.javaeditor/.settings/org.eclipse.jdt.core.prefs @@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.ui.workbench.texteditor.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.ui.workbench.texteditor.tests/.settings/org.eclipse.jdt.core.prefs index b446c773f1c..787aa457c53 100644 --- a/org.eclipse.ui.workbench.texteditor.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.ui.workbench.texteditor.tests/.settings/org.eclipse.jdt.core.prefs @@ -56,6 +56,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
diff --git a/org.eclipse.ui.workbench.texteditor/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.ui.workbench.texteditor/.settings/org.eclipse.jdt.core.prefs index 582f0e25299..528a352e472 100644 --- a/org.eclipse.ui.workbench.texteditor/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.ui.workbench.texteditor/.settings/org.eclipse.jdt.core.prefs @@ -1,4 +1,4 @@ -#Tue Jul 15 15:50:55 CEST 2008
+#Tue Aug 26 14:48:18 CEST 2008
eclipse.preferences.version=1
org.eclipse.jdt.core.builder.cleanOutputFolder=clean
org.eclipse.jdt.core.builder.duplicateResourceTask=warning
@@ -55,6 +55,7 @@ org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/DiffRegion.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/DiffRegion.java index 1238a577f7d..762bc4c33db 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/DiffRegion.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/DiffRegion.java @@ -40,11 +40,11 @@ public final class DiffRegion extends Annotation implements ILineDiffInfo { /** * Creates a new diff region. - * - * @param difference - * @param offset - * @param differences - * @param source + * + * @param difference the range difference + * @param offset the offset + * @param differences the list of diffrences + * @param source the document */ public DiffRegion(RangeDifference difference, int offset, List differences, IDocument source) { super("org.eclipse.ui.workbench.texteditor.quickdiffChange", false, null); //$NON-NLS-1$ diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/QuickDiffRestoreAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/QuickDiffRestoreAction.java index 608151874a1..2345f6ceffc 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/QuickDiffRestoreAction.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/QuickDiffRestoreAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -25,6 +25,7 @@ import org.eclipse.jface.text.source.ILineDiffer; import org.eclipse.jface.text.source.IVerticalRulerInfo; import org.eclipse.ui.IEditorInput; + import org.eclipse.ui.texteditor.IDocumentProvider; import org.eclipse.ui.texteditor.IEditorStatusLine; import org.eclipse.ui.texteditor.ITextEditor; @@ -148,9 +149,9 @@ public abstract class QuickDiffRestoreAction extends TextEditorAction implements } /** - * Returns the active line - * - * @param useRulerInfo + * Returns the active line. + * + * @param useRulerInfo <code>true</code> if ruler info should be used * @return the line of interest. * @since 3.1 */ diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/compare/rangedifferencer/LinkedRangeFactory.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/compare/rangedifferencer/LinkedRangeFactory.java index fe97cda769b..9af38bc9600 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/compare/rangedifferencer/LinkedRangeFactory.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/texteditor/quickdiff/compare/rangedifferencer/LinkedRangeFactory.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -90,11 +90,11 @@ public class LinkedRangeFactory { /** * Create a new linked range difference with the given next range and operation. - * + * * @param next the next linked range difference * @param operation the operation * @return the new linked range difference - * @throws LowMemoryException + * @throws LowMemoryException if we hit a low memory condition */ public LinkedRangeDifference newRange(LinkedRangeDifference next, int operation) throws LowMemoryException { check(); @@ -102,10 +102,11 @@ public class LinkedRangeFactory { } /** - * After <code>CHECK_INTERVAL</code> calls check whether at least a fraction of <code>THRESHOLD</code> - * of the maximal available memory is free, otherwise throw an {@link LowMemoryException}. - * - * @throws LowMemoryException + * After <code>CHECK_INTERVAL</code> calls check whether at least a fraction of + * <code>THRESHOLD</code> of the maximal available memory is free, otherwise throw an + * {@link LowMemoryException}. + * + * @throws LowMemoryException if we hit a low memory condition */ private void check() throws LowMemoryException { if (fCount % CHECK_INTERVAL == 0) { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractDocumentProvider.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractDocumentProvider.java index 47fe136e6f7..a7afb357541 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractDocumentProvider.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractDocumentProvider.java @@ -58,12 +58,12 @@ public abstract class AbstractDocumentProvider implements IDocumentProvider, IDo */ protected static abstract class DocumentProviderOperation implements IRunnableWithProgress { - /** - * The actual functionality of this operation. - * - * @param monitor a progress monitor to track execution - * @throws CoreException - */ + /** + * The actual functionality of this operation. + * + * @param monitor a progress monitor to track execution + * @throws CoreException if the execution fails + */ protected abstract void execute(IProgressMonitor monitor) throws CoreException; /* @@ -500,10 +500,10 @@ public abstract class AbstractDocumentProvider implements IDocumentProvider, IDo /** * Executes the actual work of reseting the given elements document. - * + * * @param element the element * @param monitor the progress monitor - * @throws CoreException + * @throws CoreException if resetting fails * @since 3.0 */ protected void doResetDocument(Object element, IProgressMonitor monitor) throws CoreException { @@ -897,11 +897,11 @@ public abstract class AbstractDocumentProvider implements IDocumentProvider, IDo } /** - * Informs all registered element state listeners about a change in the - * state validation of the given element. - * + * Informs all registered element state listeners about a change in the state validation of the + * given element. + * * @param element the element - * @param isStateValidated + * @param isStateValidated the flag indicating whether state validation is done * @see IElementStateListenerExtension#elementStateValidationChanged(Object, boolean) * @since 2.0 */ diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java index 904f8b04192..2ab67197a58 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java @@ -1481,12 +1481,11 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit protected abstract class AbstractSelectionChangedListener implements ISelectionChangedListener { /** - * Installs this selection changed listener with the given selection provider. If - * the selection provider is a post selection provider, post selection changed - * events are the preferred choice, otherwise normal selection changed events - * are requested. - * - * @param selectionProvider + * Installs this selection changed listener with the given selection provider. If the + * selection provider is a post selection provider, post selection changed events are the + * preferred choice, otherwise normal selection changed events are requested. + * + * @param selectionProvider the selection provider */ public void install(ISelectionProvider selectionProvider) { if (selectionProvider == null) @@ -2837,7 +2836,8 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit /** * Sets the given selection. - * @param selection + * + * @param selection the selection * @since 2.1 */ protected void doSetSelection(ISelection selection) { @@ -6398,8 +6398,8 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit /** * Updates the status fields for the given category. - * - * @param category + * + * @param category the category * @since 2.0 */ protected void updateStatusField(String category) { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ConvertLineDelimitersAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ConvertLineDelimitersAction.java index e51cc3ecc59..16d9c3d7c92 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ConvertLineDelimitersAction.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ConvertLineDelimitersAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,14 +17,15 @@ import java.util.Map; import java.util.MissingResourceException; import java.util.ResourceBundle; -import org.eclipse.core.runtime.IProgressMonitor; -import org.eclipse.core.runtime.NullProgressMonitor; - import org.eclipse.swt.custom.BusyIndicator; import org.eclipse.swt.widgets.Shell; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.NullProgressMonitor; + import org.eclipse.jface.dialogs.ProgressMonitorDialog; import org.eclipse.jface.operation.IRunnableWithProgress; + import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.IRegion; @@ -124,10 +125,11 @@ public class ConvertLineDelimitersAction extends TextEditorAction { private final String fLineDelimiter; /** - * Returns a new runnable for converting all line delimiters in - * the <code>rewriteTarget</code> to <code>lineDelimter</code>. - * @param rewriteTarget - * @param lineDelimiter + * Returns a new runnable for converting all line delimiters in the + * <code>rewriteTarget</code> to <code>lineDelimter</code>. + * + * @param rewriteTarget the rewrite target + * @param lineDelimiter the line delimiter */ public ConvertRunnable(IRewriteTarget rewriteTarget, String lineDelimiter) { fRewriteTarget= rewriteTarget; diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/DefaultRangeIndicator.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/DefaultRangeIndicator.java index d5d9555ecc6..77bfd104663 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/DefaultRangeIndicator.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/DefaultRangeIndicator.java @@ -12,9 +12,6 @@ package org.eclipse.ui.texteditor; -import org.eclipse.jface.text.source.Annotation; -import org.eclipse.jface.text.source.IAnnotationPresentation; - import org.eclipse.swt.SWT; import org.eclipse.swt.events.DisposeEvent; import org.eclipse.swt.events.DisposeListener; @@ -30,6 +27,9 @@ import org.eclipse.swt.widgets.Canvas; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; +import org.eclipse.jface.text.source.Annotation; +import org.eclipse.jface.text.source.IAnnotationPresentation; + /** * Specialized annotation to indicate a particular range of text lines. @@ -149,8 +149,8 @@ public class DefaultRangeIndicator extends Annotation implements IAnnotationPres /** * Creates and returns a new color palette data. - * - * @param display + * + * @param display the display * @return the new color palette data */ private static PaletteData createPalette(Display display) { 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 c03f41a8979..ae36743ae54 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 @@ -196,12 +196,11 @@ public class FindNextAction extends ResourceAction implements IUpdate { writeConfiguration(); } } - + /** - * Tests whether each character in the given - * string is a letter. - * - * @param str + * Tests whether each character in the given string is a letter. + * + * @param str the string to check * @return <code>true</code> if the given string is a word * @since 3.2 */ 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 5c78edd2a01..374aa1a3e1e 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 @@ -44,11 +44,11 @@ import org.eclipse.jface.fieldassist.FieldDecoration; import org.eclipse.jface.fieldassist.FieldDecorationRegistry; import org.eclipse.jface.resource.JFaceColors; +import org.eclipse.jface.text.FindReplaceDocumentAdapterContentProposalProvider; import org.eclipse.jface.text.IFindReplaceTarget; import org.eclipse.jface.text.IFindReplaceTargetExtension; import org.eclipse.jface.text.IFindReplaceTargetExtension3; import org.eclipse.jface.text.IRegion; -import org.eclipse.jface.text.FindReplaceDocumentAdapterContentProposalProvider; import org.eclipse.jface.text.Region; import org.eclipse.jface.text.TextUtilities; @@ -582,14 +582,14 @@ class FindReplaceDialog extends Dialog { findLabel.setText(EditorMessages.FindReplace_Find_label); setGridData(findLabel, SWT.LEFT, false, SWT.CENTER, false); - // Create the find content assist field + // Create the find content assist field ComboContentAdapter contentAdapter= new ComboContentAdapter(); FindReplaceDocumentAdapterContentProposalProvider findProposer= new FindReplaceDocumentAdapterContentProposalProvider(true); fFindField= new Combo(panel, SWT.DROP_DOWN | SWT.BORDER); fContentAssistFindField= new ContentAssistCommandAdapter( fFindField, contentAdapter, - findProposer, + findProposer, ITextEditorActionDefinitionIds.CONTENT_ASSIST_PROPOSALS, new char[] {'\\', '[', '('}, true); @@ -606,7 +606,7 @@ class FindReplaceDialog extends Dialog { fReplaceField= new Combo(panel, SWT.DROP_DOWN | SWT.BORDER); fContentAssistReplaceField= new ContentAssistCommandAdapter( fReplaceField, - contentAdapter, replaceProposer, + contentAdapter, replaceProposer, ITextEditorActionDefinitionIds.CONTENT_ASSIST_PROPOSALS, new char[] {'$', '\\'}, true); @@ -1562,10 +1562,9 @@ class FindReplaceDialog extends Dialog { } /** - * Tests whether each character in the given - * string is a letter. - * - * @param str + * Tests whether each character in the given string is a letter. + * + * @param str the string to check * @return <code>true</code> if the given string is a word * @since 3.0 */ @@ -1810,7 +1809,7 @@ class FindReplaceDialog extends Dialog { /** * Writes the given history into the given dialog store. * - * @param history the history + * @param history the history * @param settings the dialog settings * @param sectionName the section name * @since 3.2 diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/HippieProposalProcessor.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/HippieProposalProcessor.java index e434c87f41d..1797010053a 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/HippieProposalProcessor.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/HippieProposalProcessor.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2006 IBM Corporation and others. + * Copyright (c) 2005, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -126,7 +126,7 @@ public final class HippieProposalProcessor implements IContentAssistProcessor { return offset >= fOffset && offset < fOffset + fString.length() && document.get(prefixStart, offset - (prefixStart)).equals((fPrefix + fString).substring(0, offset - prefixStart)); } catch (BadLocationException x) { return false; - } + } } public IInformationControlCreator getInformationControlCreator() { @@ -227,11 +227,11 @@ public final class HippieProposalProcessor implements IContentAssistProcessor { } /** - * Return the list of suggestions from the current document. First the - * document is searched backwards from the caret position and then forwards. + * Return the list of suggestions from the current document. First the document is searched + * backwards from the caret position and then forwards. * - * @param offset - * @param viewer + * @param offset the offset + * @param viewer the viewer * @param prefix the completion prefix * @return all possible completions that were found in the current document * @throws BadLocationException if accessing the document fails @@ -246,15 +246,13 @@ public final class HippieProposalProcessor implements IContentAssistProcessor { } /** - * Create the array of suggestions. It scans all open text editors and - * prefers suggestions from the currently open editor. It also adds the - * empty suggestion at the end. + * Create the array of suggestions. It scans all open text editors and prefers suggestions from + * the currently open editor. It also adds the empty suggestion at the end. * - * @param viewer - * @param offset + * @param viewer the viewer + * @param offset the offset * @param prefix the prefix to search for - * @return the list of all possible suggestions in the currently open - * editors + * @return the list of all possible suggestions in the currently open editors * @throws BadLocationException if accessing the current document fails */ private List getSuggestions(ITextViewer viewer, int offset, String prefix) throws BadLocationException { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension2.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension2.java index 35ceff93bf2..29018795f1c 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension2.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProviderExtension2.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -26,7 +26,8 @@ public interface IDocumentProviderExtension2 { /** * Sets this providers progress monitor. - * @param progressMonitor + * + * @param progressMonitor the progress monitor */ void setProgressMonitor(IProgressMonitor progressMonitor); diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IReadOnlyDependent.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IReadOnlyDependent.java index f0229685a23..abddb9fa935 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IReadOnlyDependent.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IReadOnlyDependent.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -23,14 +23,13 @@ package org.eclipse.ui.texteditor; public interface IReadOnlyDependent { /** - * Returns whether the actions would be enabled if its target - * would be enabled given the writable state described by <code>isWritable</code>. - * <code>isEnabled()</code> and <code>isEnabled(boolean)</code> holds the following - * invariants: - * isEnabled() == false, if isEnabled(true) == false || isEnabled(false) == false - * isEnabled() == true, if isEnabled(true) == true || isEnabled(false) == true - * - * @param isWritable + * Returns whether the actions would be enabled if its target would be enabled given the + * writable state described by <code>isWritable</code>. <code>isEnabled()</code> and + * <code>isEnabled(boolean)</code> holds the following invariants: isEnabled() == false, if + * isEnabled(true) == false || isEnabled(false) == false isEnabled() == true, if isEnabled(true) + * == true || isEnabled(false) == true + * + * @param isWritable the writable state * @return the hypothetical enable state of the action */ boolean isEnabled(boolean isWritable); diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/JoinLinesAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/JoinLinesAction.java index 4b137a9c8b8..a4ba970c147 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/JoinLinesAction.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/JoinLinesAction.java @@ -1,12 +1,12 @@ /******************************************************************************* - * Copyright (c) 2007 IBM Corporation and others. + * Copyright (c) 2007, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: - * Benjamin Muskalla - initial API and implementation - https://bugs.eclipse.org/bugs/show_bug.cgi?id=41573 + * Benjamin Muskalla - initial API and implementation - https://bugs.eclipse.org/bugs/show_bug.cgi?id=41573 *******************************************************************************/ package org.eclipse.ui.texteditor; @@ -134,7 +134,7 @@ public class JoinLinesAction extends TextEditorAction { ITextEditor editor= getTextEditor(); setEnabled(editor.isEditable()); } - + /** * Joins several text lines to one line. * @@ -142,7 +142,7 @@ public class JoinLinesAction extends TextEditorAction { * @param startLine the start line * @param endLine the end line * @return the new caret offset - * @throws BadLocationException + * @throws BadLocationException if the document is accessed with wrong line or offset */ private int joinLines(IDocument document, int startLine, int endLine) throws BadLocationException { if (startLine == document.getNumberOfLines() - 1) { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/SourceViewerDecorationSupport.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/SourceViewerDecorationSupport.java index d05b8f4ddc0..b75271caf3e 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/SourceViewerDecorationSupport.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/SourceViewerDecorationSupport.java @@ -407,8 +407,8 @@ public class SourceViewerDecorationSupport { /** * Sets the character pair matcher for the matching character painter. - * - * @param pairMatcher + * + * @param pairMatcher the character pair matcher */ public void setCharacterPairMatcher(ICharacterPairMatcher pairMatcher) { fCharacterPairMatcher= pairMatcher; @@ -473,7 +473,8 @@ public class SourceViewerDecorationSupport { /** * Sets the symbolic font name that is used for computing the margin width. - * @param symbolicFontName + * + * @param symbolicFontName the symbolic font name */ public void setSymbolicFontName(String symbolicFontName) { fSymbolicFontName= symbolicFontName; diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java index 6c905ca6708..b0dd13018ea 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -288,7 +288,7 @@ public class StatusLineContributionItem extends ContributionItem implements ISta /** * Escapes '&' with '&' in the given text. * - * @param text + * @param text the text to escape * @return the escaped string * @since 3.4 */ diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/TextViewerDeleteLineTarget.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/TextViewerDeleteLineTarget.java index 6c7d32c8c4a..3939b4c4c2f 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/TextViewerDeleteLineTarget.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/TextViewerDeleteLineTarget.java @@ -256,14 +256,14 @@ public class TextViewerDeleteLineTarget implements IDeleteLineTarget { /** * Returns the document's delete region specified by position and type. - * - * @param document the document + * + * @param document the document * @param offset the offset * @param length the length - * @param type the line deletion type, must be one of - * <code>WHOLE_LINE</code>, <code>TO_BEGINNING</code> or <code>TO_END</code> + * @param type the line deletion type, must be one of <code>WHOLE_LINE</code>, + * <code>TO_BEGINNING</code> or <code>TO_END</code> * @return the document's delete region - * @throws BadLocationException + * @throws BadLocationException if the document is accessed with invalid offset or line */ private IRegion getDeleteRegion(IDocument document, int offset, int length, int type) throws BadLocationException { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ValidateStateException.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ValidateStateException.java index 65a8f6df808..ebb2e6c1377 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ValidateStateException.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ValidateStateException.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -20,8 +20,8 @@ import org.eclipse.core.runtime.IStatus; * <p> * This class is not intended to be serialized. * </p> - * - * @deprecated + * + * @deprecated No longer used, create a {@link CoreException} instead * @since 2.1 */ public class ValidateStateException extends CoreException { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/EditorLinkedModeUI.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/EditorLinkedModeUI.java index 0d83c1d5665..9ddf58d96bc 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/EditorLinkedModeUI.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/EditorLinkedModeUI.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -59,37 +59,21 @@ public class EditorLinkedModeUI extends LinkedModeUI { } - /** - * @param model - * @param viewer - */ public EditorLinkedModeUI(LinkedModeModel model, ITextViewer viewer) { super(model, viewer); setPositionListener(new EditorHistoryUpdater()); } - /** - * @param model - * @param viewers - */ public EditorLinkedModeUI(LinkedModeModel model, ITextViewer[] viewers) { super(model, viewers); setPositionListener(new EditorHistoryUpdater()); } - /** - * @param model - * @param target - */ public EditorLinkedModeUI(LinkedModeModel model, LinkedModeUITarget target) { super(model, target); setPositionListener(new EditorHistoryUpdater()); } - /** - * @param model - * @param targets - */ public EditorLinkedModeUI(LinkedModeModel model, LinkedModeUITarget[] targets) { super(model, targets); setPositionListener(new EditorHistoryUpdater()); diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java index 695577b89b5..bc7195f8c21 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java @@ -177,7 +177,7 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Check whether an update of the AbstractTemplatesPage is needed * - * @param contextTypes + * @param contextTypes the context types * @return true if update is needed */ private boolean needUpdate(String[] contextTypes) { @@ -189,7 +189,7 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Check whether there is any change in the context types needed * - * @param contextTypes + * @param contextTypes the context types * @return true if any of the context types changed */ private boolean contextTypeChanged(String[] contextTypes) { @@ -617,9 +617,10 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Update the pattern viewer to show the current template. * <p> - * Subclasses can extend this method to update their own pattern viewer.</p> + * Subclasses can extend this method to update their own pattern viewer. + * </p> * - * @param template + * @param template the template */ protected void updatePatternViewer(Template template) { String pattern= template != null ? template.getPattern() : ""; //$NON-NLS-1$ @@ -776,7 +777,7 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Convert the clipboard contents into a template * - * @param clipboard + * @param clipboard the clipboard * @return the template or null if contents are not valid */ private Template getTemplateFromClipboard(Clipboard clipboard) { @@ -969,9 +970,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Fill the toolbar + * Fill the toolbar. * - * @param actionBars + * @param actionBars the action bars */ private void fillToolbar(IActionBars actionBars) { IToolBarManager toolBarManager= actionBars.getToolBarManager(); @@ -987,9 +988,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Fill the view menu + * Fill the view menu. * - * @param actionBars + * @param actionBars the action bars */ private void fillMenu(IActionBars actionBars) { IMenuManager menuManager= actionBars.getMenuManager(); @@ -1003,9 +1004,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Fill the context menu items + * Fill the context menu items. * - * @param manager + * @param manager the menu manager */ private void fillContextMenu(IMenuManager manager) { manager.add(fInsertAction); @@ -1021,9 +1022,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Create the tree to display templates + * Create the tree to display templates. * - * @param parent + * @param parent the parent composite */ private void createTemplateTree(Composite parent) { Composite treeComposite= new Composite(parent, SWT.NONE); @@ -1077,9 +1078,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Create the tree viewer and setup the providers + * Create the tree viewer and setup the providers. * - * @param templatesTree + * @param templatesTree the tree used to show the templates */ private void createTreeViewer(Tree templatesTree) { fTreeViewer= new TreeViewer(fTemplatesTree); @@ -1107,9 +1108,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Setup the pattern viewer + * Setup the pattern viewer. * - * @param parent + * @param parent the parent composite */ private void createPatternForm(Composite parent) { ViewForm viewForm= new ViewForm(parent, SWT.NONE); @@ -1281,10 +1282,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Returns the context id for the given item which is either a template or a - * context type. + * Returns the context id for the given item which is either a template or a context type. * - * @param item + * @param item the item * @return the context type id */ private String getContextId(Object item) { @@ -1297,10 +1297,9 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Add a template. The dialog is filled with the values from the given - * template. + * Add a template. The dialog is filled with the values from the given template. * - * @param template + * @param template the template */ private void addTemplate(Template template) { Template newTemplate; @@ -1351,10 +1350,10 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa } /** - * Moves the selected template from one context to another + * Moves the selected template from one context to another. * - * @param templates - * @param contextId + * @param templates an array of template data + * @param contextId the contextId * */ private void moveTemplates(TemplatePersistenceData[] templates, String contextId) { @@ -1370,8 +1369,8 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Copy the selected templates to another context * - * @param templates - * @param contextId + * @param templates an array of template data + * @param contextId the context id * */ private void copyTemplates(TemplatePersistenceData[] templates, String contextId) { @@ -1581,11 +1580,11 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa /** * Returns the document relative offset from the text widget relative point * - * @param document - * @param textWidget - * @param point + * @param document the document + * @param textWidget the text widget + * @param point the point for which to get the offset * @return the offset - * @throws BadLocationException + * @throws BadLocationException if the document is accessed with an invalid line */ private int getOffset(IDocument document, StyledText textWidget, Point point) throws BadLocationException { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatePreferencePage.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatePreferencePage.java index 08d98b9054b..c7090684f06 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatePreferencePage.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatePreferencePage.java @@ -1019,8 +1019,9 @@ public abstract class TemplatePreferencePage extends PreferencePage implements I } /** - * Creates a separator between buttons - * @param parent + * Creates a separator between buttons. + * + * @param parent the parent composite * @return a separator */ private Label createSeparator(Composite parent) { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesPageImages.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesPageImages.java index 60cf350dd9b..f62a3bc7e94 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesPageImages.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesPageImages.java @@ -33,36 +33,50 @@ import org.eclipse.ui.internal.texteditor.TextEditorPlugin; */ class TemplatesPageImages { - static final String PREFIX_ELCL = TextEditorPlugin.PLUGIN_ID + ".elcl."; //$NON-NLS-1$ - static final String PREFIX_DLCL = TextEditorPlugin.PLUGIN_ID + ".dlcl."; //$NON-NLS-1$ - static final String PREFIX_OBJ = TextEditorPlugin.PLUGIN_ID + ".obj."; //$NON-NLS-1$ - - public static final String IMG_ELCL_TEMPLATE_NEW = PREFIX_ELCL + "new_template.gif"; //$NON-NLS-1$ - public static final String IMG_ELCL_TEMPLATE_DELETE = PREFIX_ELCL + "delete_template.gif"; //$NON-NLS-1$ - public static final String IMG_ELCL_TEMPLATE_EDIT = PREFIX_ELCL + "edit_template.gif"; //$NON-NLS-1$ - public static final String IMG_ELCL_TEMPLATE_INSERT = PREFIX_ELCL + "insert_template.gif"; //$NON-NLS-1$ - public static final String IMG_ELCL_TEMPLATE_LINK = PREFIX_ELCL + "link_to_editor.gif"; //$NON-NLS-1$ - public static final String IMG_ELCL_TEMPLATE_COLLAPSE_ALL = PREFIX_ELCL + "collapseall.gif"; //$NON-NLS-1$ - public static final String IMG_DLCL_TEMPLATE_DELETE = PREFIX_DLCL + "delete_template.gif"; //$NON-NLS-1$ - public static final String IMG_DLCL_TEMPLATE_EDIT = PREFIX_DLCL + "edit_template.gif"; //$NON-NLS-1$ - public static final String IMG_DLCL_TEMPLATE_INSERT = PREFIX_DLCL + "insert_template.gif"; //$NON-NLS-1$ - - public static final String IMG_OBJ_PREVIEW = PREFIX_OBJ + "preview.gif"; //$NON-NLS-1$ - public static final String IMG_OBJ_CONTEXT = PREFIX_OBJ + "context.gif"; //$NON-NLS-1$ - public static final String IMG_OBJ_TEMPLATE = PREFIX_OBJ + "template_obj.gif"; //$NON-NLS-1$ + static final String PREFIX_ELCL= TextEditorPlugin.PLUGIN_ID + ".elcl."; //$NON-NLS-1$ + + static final String PREFIX_DLCL= TextEditorPlugin.PLUGIN_ID + ".dlcl."; //$NON-NLS-1$ + + static final String PREFIX_OBJ= TextEditorPlugin.PLUGIN_ID + ".obj."; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_NEW= PREFIX_ELCL + "new_template.gif"; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_DELETE= PREFIX_ELCL + "delete_template.gif"; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_EDIT= PREFIX_ELCL + "edit_template.gif"; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_INSERT= PREFIX_ELCL + "insert_template.gif"; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_LINK= PREFIX_ELCL + "link_to_editor.gif"; //$NON-NLS-1$ + + public static final String IMG_ELCL_TEMPLATE_COLLAPSE_ALL= PREFIX_ELCL + "collapseall.gif"; //$NON-NLS-1$ + + public static final String IMG_DLCL_TEMPLATE_DELETE= PREFIX_DLCL + "delete_template.gif"; //$NON-NLS-1$ + + public static final String IMG_DLCL_TEMPLATE_EDIT= PREFIX_DLCL + "edit_template.gif"; //$NON-NLS-1$ + + public static final String IMG_DLCL_TEMPLATE_INSERT= PREFIX_DLCL + "insert_template.gif"; //$NON-NLS-1$ + + public static final String IMG_OBJ_PREVIEW= PREFIX_OBJ + "preview.gif"; //$NON-NLS-1$ + + public static final String IMG_OBJ_CONTEXT= PREFIX_OBJ + "context.gif"; //$NON-NLS-1$ + + public static final String IMG_OBJ_TEMPLATE= PREFIX_OBJ + "template_obj.gif"; //$NON-NLS-1$ /** * The image registry containing {@link Image images}. */ private static ImageRegistry fgImageRegistry; - private static String ICONS_PATH = "$nl$/icons/full/"; //$NON-NLS-1$ + private static String ICONS_PATH= "$nl$/icons/full/"; //$NON-NLS-1$ // Use IPath and toOSString to build the names to ensure they have the // slashes correct - private final static String ELCL = ICONS_PATH + "elcl16/"; //$NON-NLS-1$ - private final static String DLCL = ICONS_PATH + "dlcl16/"; //$NON-NLS-1$ - private final static String OBJ = ICONS_PATH + "obj16/"; //$NON-NLS-1$ + private final static String ELCL= ICONS_PATH + "elcl16/"; //$NON-NLS-1$ + + private final static String DLCL= ICONS_PATH + "dlcl16/"; //$NON-NLS-1$ + + private final static String OBJ= ICONS_PATH + "obj16/"; //$NON-NLS-1$ /** * Declare all images @@ -87,20 +101,17 @@ class TemplatesPageImages { /** * Declare an Image in the registry table. * - * @param key - * The key to use when registering the image - * @param path - * The path where the image can be found. This path is relative - * to where this plugin class is found (i.e. typically the - * packages directory) + * @param key the key to use when registering the image + * @param path the path where the image can be found. This path is relative to where this plugin + * class is found (i.e. typically the packages directory) */ private final static void declareRegistryImage(String key, String path) { - ImageDescriptor desc = ImageDescriptor.getMissingImageDescriptor(); - Bundle bundle = Platform.getBundle(TextEditorPlugin.PLUGIN_ID); - URL url = null; + ImageDescriptor desc= ImageDescriptor.getMissingImageDescriptor(); + Bundle bundle= Platform.getBundle(TextEditorPlugin.PLUGIN_ID); + URL url= null; if (bundle != null) { - url = FileLocator.find(bundle, new Path(path), null); - desc = ImageDescriptor.createFromURL(url); + url= FileLocator.find(bundle, new Path(path), null); + desc= ImageDescriptor.createFromURL(url); } fgImageRegistry.put(key, desc); } @@ -118,27 +129,24 @@ class TemplatesPageImages { } /** - * Initialize the image registry by declaring all of the required graphics. - * This involves creating JFace image descriptors describing how to - * create/find the image should it be needed. The image is not actually - * allocated until requested. + * Initialize the image registry by declaring all of the required graphics. This involves + * creating JFace image descriptors describing how to create/find the image should it be needed. + * The image is not actually allocated until requested. * - * Prefix conventions Wizard Banners WIZBAN_ Preference Banners PREF_BAN_ - * Property Page Banners PROPBAN_ Color toolbar CTOOL_ Enable toolbar ETOOL_ - * Disable toolbar DTOOL_ Local enabled toolbar ELCL_ Local Disable toolbar - * DLCL_ Object large OBJL_ Object small OBJS_ View VIEW_ Product images - * PROD_ Misc images MISC_ + * Prefix conventions Wizard Banners WIZBAN_ Preference Banners PREF_BAN_ Property Page Banners + * PROPBAN_ Color toolbar CTOOL_ Enable toolbar ETOOL_ Disable toolbar DTOOL_ Local enabled + * toolbar ELCL_ Local Disable toolbar DLCL_ Object large OBJL_ Object small OBJS_ View VIEW_ + * Product images PROD_ Misc images MISC_ * - * Where are the images? The images (typically gifs) are found in the same - * location as this plugin class. This may mean the same package directory - * as the package holding this class. The images are declared using - * this.getClass() to ensure they are looked up via this plugin class. + * Where are the images? The images (typically gifs) are found in the same location as this + * plugin class. This may mean the same package directory as the package holding this class. The + * images are declared using this.getClass() to ensure they are looked up via this plugin class. * * @return the image registry * @see org.eclipse.jface.resource.ImageRegistry */ public static ImageRegistry initializeImageRegistry() { - fgImageRegistry = TextEditorPlugin.getDefault().getImageRegistry(); + fgImageRegistry= TextEditorPlugin.getDefault().getImageRegistry(); declareImages(); return fgImageRegistry; } |