diff options
author | Alexander Kurtakov | 2019-02-16 10:06:56 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-16 10:06:56 +0000 |
commit | bd41efff8beecfdd9c83f1f3a8125177b474be9d (patch) | |
tree | 9ba28c08b66dc157b677adb1f9bbdc348d57277e /org.eclipse.jface.text | |
parent | 3ca075b6da7f6baef7dfe36690bb3b1fa6fa6e58 (diff) | |
download | eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.tar.gz eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.tar.xz eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.zip |
Bug 543933 - Build javadocs with Java 11I20190216-0600
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: Iac131bfc027cf0d7de92992b6518764ce0b568d9
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.jface.text')
7 files changed, 31 insertions, 24 deletions
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 bf3dbacaacc..1fa6b6f45e9 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 @@ -214,16 +214,18 @@ public interface IContentAssistSubjectControl { void addKeyListener(KeyListener keyListener); /** - * Removes the listener from the collection of listeners who will be - * notified when keys are pressed and released on the system keyboard. + * Removes the listener from the collection of listeners who will be notified when keys are + * pressed and released on the system keyboard. * * @param keyListener the listener which should be notified - * @exception IllegalArgumentException if the listener is null</li> + * @exception IllegalArgumentException if the listener is null * @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> - * </ul> + * <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> + * </ul> * @see KeyListener * @see #addKeyListener(KeyListener) */ @@ -243,11 +245,13 @@ public interface IContentAssistSubjectControl { * <p> * * @param selectionListener the listener - * @exception org.eclipse.swt.SWTException <ul> - * <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> - * </ul> + * @exception org.eclipse.swt.SWTException + * <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> + * </ul> * @exception IllegalArgumentException if listener is <code>null</code> */ void removeSelectionListener(SelectionListener selectionListener); 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 ea9234e7a42..710beacbbca 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 @@ -548,13 +548,13 @@ abstract public class AbstractInformationControlManager { * </p> * <p> * The constants used to store the values are: + * </p> * <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> * </ul> - * </p> * * @param dialogSettings the dialog settings * @param restoreLocation <code>true</code> iff the location is must be (re-)stored 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 f5820034e28..b72276c23af 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 @@ -1654,12 +1654,13 @@ public class TextViewer extends Viewer implements } /** - * Create a new text viewer with the given SWT style bits. - * The viewer is ready to use but does not have any plug-in installed. + * Create a new text viewer with the given SWT style bits. The viewer is ready to use but does + * not have any plug-in installed. * * @param parent the parent of the viewer's control - * @param styles the SWT style bits for the viewer's control, - * <em>if <code>SWT.WRAP</code> is set then a custom document adapter needs to be provided, see {@link #createDocumentAdapter()} + * @param styles the SWT style bits for the viewer's control, if <code>SWT.WRAP</code> is set + * then a custom document adapter needs to be provided, see + * {@link #createDocumentAdapter()} */ public TextViewer(Composite parent, int styles) { createControl(parent, styles); 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 f4c66bf62c2..79ef8c91448 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 @@ -1076,7 +1076,7 @@ public class ContentAssistant implements IContentAssistant, IContentAssistantExt * enabled, without further configuration steps, this content assistant is activated after a 500 * milliseconds delay. It uses the default partitioning. * - * @param asynchronous <true> if this content assistant should present the proposals + * @param asynchronous <code>true</code> if this content assistant should present the proposals * asynchronously, <code>false</code> otherwise * @since 3.12 */ @@ -2309,13 +2309,13 @@ public class ContentAssistant implements IContentAssistant, IContentAssistantExt * </p> * <p> * The constants used to store the values are: + * </p> * <ul> * <li>{@link ContentAssistant#STORE_SIZE_X}</li> * <li>{@link ContentAssistant#STORE_SIZE_Y}</li> * <li>{@link ContentAssistant#STORE_CONTEXT_SELECTOR_POPUP_SIZE_X}</li> * <li>{@link ContentAssistant#STORE_CONTEXT_SELECTOR_POPUP_SIZE_Y}</li> * </ul> - * </p> * * @param dialogSettings the dialog settings * @since 3.0 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 a5946abc7ee..d06bbc5d1de 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 @@ -54,9 +54,11 @@ public interface IContentFormatterExtension { * <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. + * </p> * <p> * The formatting process performed by <code>format(IDocument, IFormattingContext)</code> * happens as follows: + * </p> * <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 @@ -65,6 +67,7 @@ public interface IContentFormatterExtension { * 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> + * </ul> * * @param document the document to be formatted * @param context the formatting context to pass to the formatting strategies. This argument diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/QuickAssistAssistant.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/QuickAssistAssistant.java index 17f51d41a24..1d477e828ba 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/QuickAssistAssistant.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/QuickAssistAssistant.java @@ -160,9 +160,8 @@ public class QuickAssistAssistant implements IQuickAssistAssistant, IQuickAssist } /** - * Tells this assistant to open the proposal popup with the size - * contained in the given dialog settings and to store the control's last valid size in the - * given dialog settings. + * Tells this assistant to open the proposal popup with the size 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 org.eclipse.jface.text.IInformationControlExtension3}. Not following this restriction @@ -170,11 +169,11 @@ public class QuickAssistAssistant implements IQuickAssistAssistant, IQuickAssist * </p> * <p> * The constants used to store the values are: + * </p> * <ul> * <li>{@link ContentAssistant#STORE_SIZE_X}</li> * <li>{@link ContentAssistant#STORE_SIZE_Y}</li> * </ul> - * </p> * * @param dialogSettings the dialog settings * @since 3.7 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffInfo.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffInfo.java index e6f14184f57..0af9a96218a 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffInfo.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffInfo.java @@ -70,7 +70,7 @@ public interface ILineDiffInfo { * Returns the original text of this changed region * * @return the original text of this changed region, including any deleted lines. The returned - * value and its elements may not be <code>null/code>, it may however be of zero length + * value and its elements may not be <code>null</code>, it may however be of zero length */ String[] getOriginalText(); } |