From 1fb70c44cdadcbdff87a191e446fc4a071a31cd7 Mon Sep 17 00:00:00 2001 From: Alexander Kurtakov Date: Mon, 18 Feb 2019 23:15:30 +0200 Subject: Bug 543933 - Build javadocs with Java 11 After fixing majority of Xdoclint:html issues there are warnings even with Xdoclint:none. Change-Id: I9be510daa74198061f829b73116c38c19dfd400f Signed-off-by: Alexander Kurtakov --- .../src/org/eclipse/jface/text/TextAttribute.java | 8 +- .../src/org/eclipse/jface/text/TextViewer.java | 16 ++-- .../source/ICharacterPairMatcherExtension.java | 3 +- .../eclipse/jface/text/source/LineChangeHover.java | 11 ++- .../jface/text/templates/persistence/package.html | 2 +- .../org/eclipse/search/ui/ISearchResultView.java | 103 ++++++++++++--------- .../src/org/eclipse/jface/text/Position.java | 6 +- .../text/source/IAnnotationModelExtension2.java | 4 +- .../texteditor/ITextEditorActionDefinitionIds.java | 28 ++++-- 9 files changed, 105 insertions(+), 76 deletions(-) diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextAttribute.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextAttribute.java index c11c93beebf..bff933aaed1 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextAttribute.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextAttribute.java @@ -28,15 +28,15 @@ import org.eclipse.swt.graphics.Font; public class TextAttribute { /** - * Text attribute for strikethrough style. - * (value 1 << 29). + * Text attribute for strikethrough style. (value 1 << 29). + * * @since 3.1 */ public static final int STRIKETHROUGH= 1 << 29; /** - * Text attribute for underline style. - * (value 1 << 30) + * Text attribute for underline style. (value 1 << 30) + * * @since 3.1 */ public static final int UNDERLINE= 1 << 30; 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 b72276c23af..75feb94457f 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 @@ -1558,7 +1558,8 @@ public class TextViewer extends Viewer implements protected Map> fAutoIndentStrategies; /** The text viewer's text hovers */ protected Map fTextHovers; - /** All registered view port listeners> */ + + /** All registered view port listeners */ protected List fViewportListeners; /** The last visible vertical position of the top line */ protected int fLastTopPixel; @@ -3224,14 +3225,13 @@ public class TextViewer extends Viewer implements } /** - * Returns the region covered by the given start and end offset. - * The result is relative to the upper left corner of the widget - * client area. + * Returns the region covered by the given start and end offset. The result is relative to the + * upper left corner of the widget client area. * - * @param start offset relative to the start of this viewer's view port - * 0 <= offset <= getCharCount() - * @param end offset relative to the start of this viewer's view port - * 0 <= offset <= getCharCount() + * @param start offset relative to the start of this viewer's view port 0 <= offset <= + * getCharCount() + * @param end offset relative to the start of this viewer's view port 0 <= offset <= + * getCharCount() * @return the region covered by start and end offset */ final protected IRegion getExtent(int start, int end) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcherExtension.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcherExtension.java index 34a8abe868b..b60649848a9 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcherExtension.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcherExtension.java @@ -67,7 +67,8 @@ public interface ICharacterPairMatcherExtension { * *

* Clients can use this method to handle characters which may have special meaning in some - * situations. E.g. in Java, '<' is used as an angular bracket and as well as less-than operator. + * situations. E.g. in Java, '<' is used as an angular bracket and as well as less-than + * operator. *

* * @param ch the character diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineChangeHover.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineChangeHover.java index 7108f06a05d..780929a4492 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineChangeHover.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/LineChangeHover.java @@ -101,15 +101,16 @@ public class LineChangeHover implements IAnnotationHover, IAnnotationHoverExtens } /** - * Takes a list of ILineDiffInfos and computes a hover of at most maxLines. - * Added lines are prefixed with a '+', changed lines with '>' and - * deleted lines with '-'. - *

Deleted and added lines can even each other out, so that a number of deleted lines get + * Takes a list of ILineDiffInfos and computes a hover of at most + * maxLines. Added lines are prefixed with a '+', changed lines with + * '>' and deleted lines with '-'. + *

+ * Deleted and added lines can even each other out, so that a number of deleted lines get * displayed where - in the current document - the added lines are. * * @param diffInfos a List of ILineDiffInfo * @param maxLines the maximum number of lines. Note that adding up all annotations might give - * more than that due to deleted lines. + * more than that due to deleted lines. * @return a String suitable for hover display */ protected String decorateText(List diffInfos, int maxLines) { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html index 79efa958651..7f5e717732e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html @@ -12,7 +12,7 @@ Provides persistence support for templates.

Packages

    -
  • org.eclipse.jface.text.templates<
    • +
  • org.eclipse.jface.text.templates
  • org.eclipse.ui.workbench.texteditor.templates
  • org.eclipse.ui.editors.templates
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java index 09ed5fad8eb..19696cbc6d0 100644 --- a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java +++ b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java @@ -94,25 +94,34 @@ public interface ISearchResultView extends IViewPart { public ISelection getSelection(); /** - * Informs the view that a search has started. - * Provides all necessary information to create an entry in the search result - * view. - * If every match should show up in the search result view then the match - * itself can be used as key. + * Informs the view that a search has started. Provides all necessary + * information to create an entry in the search result view. If every match + * should show up in the search result view then the match itself can be + * used as key. * - * @param pageId the id of the search page which started the search - * @param label the label to be used for this search occurrence - * @param imageDescriptor the image descriptor to be used for this search occurrence, - * or null if this search should not have an image - * @param contributor the context menu contributor - * or null if no context menu is contributed - * @param labelProvider the label provider used by this search result view - * or null if the default provider should be used. - * The default label provider shows the resource name and the corresponding image. - * @param gotoAction the action used by the view to go to a marker - * @param groupByKeyComputer the computer used by the view to compute the key for a marker - * @param operation the runnable used by the view to repeat the search - * @deprecated As of build > 20011107, replaced by the new version with additional parameter + * @param pageId + * the id of the search page which started the search + * @param label + * the label to be used for this search occurrence + * @param imageDescriptor + * the image descriptor to be used for this search occurrence, or + * null if this search should not have an image + * @param contributor + * the context menu contributor or null if no + * context menu is contributed + * @param labelProvider + * the label provider used by this search result view or + * null if the default provider should be used. The + * default label provider shows the resource name and the + * corresponding image. + * @param gotoAction + * the action used by the view to go to a marker + * @param groupByKeyComputer + * the computer used by the view to compute the key for a marker + * @param operation + * the runnable used by the view to repeat the search + * @deprecated As of build > 20011107, replaced by the new version with + * additional parameter */ @Deprecated public void searchStarted( @@ -126,31 +135,41 @@ public interface ISearchResultView extends IViewPart { IRunnableWithProgress operation); /** - * Informs the view that a search has started. - * Provides all necessary information to create an entry in the search result - * view. - * If every match should show up in the search result view then the match - * itself can be used as key. + * Informs the view that a search has started. Provides all necessary + * information to create an entry in the search result view. If every match + * should show up in the search result view then the match itself can be + * used as key. * - * @param pageId the id of the search page which started the search - * @param singularLabel the label to be used for this search occurrence - * if there is one match - * or null if the pluralLabelPattern should be used - * @param pluralLabelPattern the label pattern to be used for this search occurrence - * if there are more than one matches or none. - * This string may contain {0} which will be replace by the match count - * @param imageDescriptor the image descriptor to be used for this search occurrence, - * or null if this search should not have an image - * @param contributor the context menu contributor - * or null if no context menu is contributed - * @param labelProvider the label provider used by this search result view - * or null if the default provider should be used. - * The default label provider shows the resource name and the corresponding image. - * @param gotoAction the action used by the view to go to a marker - * @param groupByKeyComputer the computer used by the view to compute the key for a marker - * @param operation the runnable used by the view to repeat the search - * @since 2.0 - * @deprecated As of build > 20020514, replaced by the new version which provides an action group factory + * @param pageId + * the id of the search page which started the search + * @param singularLabel + * the label to be used for this search occurrence if there is + * one match or null if the pluralLabelPattern + * should be used + * @param pluralLabelPattern + * the label pattern to be used for this search occurrence if + * there are more than one matches or none. This string may + * contain {0} which will be replace by the match count + * @param imageDescriptor + * the image descriptor to be used for this search occurrence, or + * null if this search should not have an image + * @param contributor + * the context menu contributor or null if no + * context menu is contributed + * @param labelProvider + * the label provider used by this search result view or + * null if the default provider should be used. The + * default label provider shows the resource name and the + * corresponding image. + * @param gotoAction + * the action used by the view to go to a marker + * @param groupByKeyComputer + * the computer used by the view to compute the key for a marker + * @param operation + * the runnable used by the view to repeat the search + * @since 2.0 + * @deprecated As of build > 20020514, replaced by the new version which + * provides an action group factory */ @Deprecated public void searchStarted( diff --git a/org.eclipse.text/src/org/eclipse/jface/text/Position.java b/org.eclipse.text/src/org/eclipse/jface/text/Position.java index 064f8fdb40a..1239d9eb77d 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/Position.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/Position.java @@ -49,7 +49,7 @@ public class Position { /** * Creates a new position with the given offset and length 0. * - * @param offset the position offset, must be >= 0 + * @param offset the position offset, must be >= 0 */ public Position(int offset) { this(offset, 0); @@ -58,8 +58,8 @@ public class Position { /** * Creates a new position with the given offset and length. * - * @param offset the position offset, must be >= 0 - * @param length the position length, must be >= 0 + * @param offset the position offset, must be >= 0 + * @param length the position length, must be >= 0 */ public Position(int offset, int length) { Assert.isTrue(offset >= 0); diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension2.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension2.java index 1367cbe628c..9011e83e2f5 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension2.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension2.java @@ -28,8 +28,8 @@ public interface IAnnotationModelExtension2 { * Returns an iterator over all annotations managed by this model that are * inside the given region. * - * @param offset the start position of the region, must be >= 0 - * @param length the length of the region, must be >= 0 + * @param offset the start position of the region, must be >= 0 + * @param length the length of the region, must be >= 0 * @param canStartBefore if true then annotations are included * which start before the region if they end at or after the region's start * @param canEndAfter if true then annotations are included diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionDefinitionIds.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionDefinitionIds.java index 566ee0523c1..8ee59776c76 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionDefinitionIds.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionDefinitionIds.java @@ -456,35 +456,42 @@ public interface ITextEditorActionDefinitionIds extends IWorkbenchActionDefiniti String GOTO_PREVIOUS_ANNOTATION= "org.eclipse.ui.edit.text.gotoPreviousAnnotation"; //$NON-NLS-1$ /** - * Action definition ID of the edit -> content assist proposal action + * Action definition ID of the edit -> content assist proposal action * Value: "org.eclipse.ui.edit.text.contentAssist.proposals"). *

* Note: Since 3.2 the command is defined in org.eclipse.ui and - * its ID can also be accessed using {@link org.eclipse.ui.fieldassist.ContentAssistCommandAdapter#CONTENT_PROPOSAL_COMMAND}. + * its ID can also be accessed using + * {@link org.eclipse.ui.fieldassist.ContentAssistCommandAdapter#CONTENT_PROPOSAL_COMMAND}. *

+ * * @since 2.1 */ String CONTENT_ASSIST_PROPOSALS= "org.eclipse.ui.edit.text.contentAssist.proposals"; //$NON-NLS-1$ /** - * Action definition ID of the edit -> content assist context information action - * Value: "org.eclipse.ui.edit.text.contentAssist.contextInformation"). + * Action definition ID of the edit -> content assist context information + * action Value: + * "org.eclipse.ui.edit.text.contentAssist.contextInformation"). + * * @since 2.1 */ String CONTENT_ASSIST_CONTEXT_INFORMATION= "org.eclipse.ui.edit.text.contentAssist.contextInformation"; //$NON-NLS-1$ /** - * Action definition ID of the edit -> quick assist proposal action + * Action definition ID of the edit -> quick assist proposal action *

- * Note: The constant contains 'jdt' for historical and compatibility reasons. + * Note: The constant contains 'jdt' for historical and compatibility + * reasons. *

- * (value "org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals"). + * (value + * "org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals"). + * * @since 3.2 */ String QUICK_ASSIST= "org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals"; //$NON-NLS-1$ /** - * Action definition ID of the edit -> smart insert mode action + * Action definition ID of the edit -> smart insert mode action * Value: "org.eclipse.ui.edit.text.toggleInsertMode"). * @since 3.0 */ @@ -526,8 +533,9 @@ public interface ITextEditorActionDefinitionIds extends IWorkbenchActionDefiniti String LINENUMBER_TOGGLE= "org.eclipse.ui.editors.lineNumberToggle"; //$NON-NLS-1$ /** - * Action definition ID of the edit -> text complete action - * Value: "org.eclipse.ui.edit.text.hippieCompletion"). + * Action definition ID of the edit -> text complete action Value: + * "org.eclipse.ui.edit.text.hippieCompletion"). + * * @since 3.1 */ String HIPPIE_COMPLETION= "org.eclipse.ui.edit.text.hippieCompletion"; //$NON-NLS-1$ -- cgit v1.2.3