From 4466a92c1607ffafb97f447841920ac62148ce12 Mon Sep 17 00:00:00 2001 From: Alexander Kurtakov Date: Wed, 13 Feb 2019 14:41:09 +0200 Subject: Bug 543933 - Build javadocs with Java 11 Fix javadoc warnings catched by Java 11 tool. Change-Id: I077488664870277e1a7b4f8ab729c7ead1fcf5b0 Signed-off-by: Alexander Kurtakov --- .../org/eclipse/compare/CompareEditorInput.java | 16 +++--- .../compare/org/eclipse/compare/HistoryItem.java | 1 - .../contentmergeviewer/ContentMergeViewer.java | 28 ++++++---- .../contentmergeviewer/TextMergeViewer.java | 65 ++++++++++++---------- .../structuremergeviewer/IStructureCreator.java | 2 + 5 files changed, 62 insertions(+), 50 deletions(-) diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java index 8f0be776a..56895651d 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java @@ -1159,13 +1159,13 @@ public abstract class CompareEditorInput extends PlatformObject implements IEdit } /** - * Saves any unsaved changes. - * Subclasses must override to save any changes. - * This implementation tries to flush changes in all viewers by - * calling ISavable.save on them. + * Saves any unsaved changes. Subclasses must override to save any changes. This + * implementation tries to flush changes in all viewers by calling + * ISavable.save on them. * - * @param monitor an IProgressMonitor that the implementation of save may use to show progress - * @throws CoreException + * @param monitor an IProgressMonitor that the implementation of + * save may use to show progress + * @throws CoreException If save fails. * @since 2.0 */ public void saveChanges(IProgressMonitor monitor) throws CoreException { @@ -1188,7 +1188,7 @@ public abstract class CompareEditorInput extends PlatformObject implements IEdit } /** - * @param monitor + * @param monitor a progress monitor * @noreference This method is not intended to be referenced by clients. */ protected void flushLeftViewers(IProgressMonitor monitor) { @@ -1200,7 +1200,7 @@ public abstract class CompareEditorInput extends PlatformObject implements IEdit } /** - * @param monitor + * @param monitor a progress monitor * @noreference This method is not intended to be referenced by clients. */ protected void flushRightViewers(IProgressMonitor monitor) { diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/HistoryItem.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/HistoryItem.java index 37a265145..2dffe8a49 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/HistoryItem.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/HistoryItem.java @@ -29,7 +29,6 @@ import org.eclipse.swt.graphics.Image; * an input to a compare viewer or other places where an IStreamContentAccessor * is needed. *

- *

* Clients may instantiate this class; it is not intended to be subclassed. *

* @noextend This class is not intended to be subclassed by clients. diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java index d7fe610a8..1d8a071eb 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java @@ -87,27 +87,31 @@ import org.eclipse.ui.Saveable; /** - * An abstract compare and merge viewer with two side-by-side content areas - * and an optional content area for the ancestor. The implementation makes no + * An abstract compare and merge viewer with two side-by-side content areas and + * an optional content area for the ancestor. The implementation makes no * assumptions about the content type. *

* ContentMergeViewer + *

* - * A ContentMergeViewer accesses its - * model by means of a content provider which must implement the - * IMergeViewerContentProvider interface. + *

+ * A ContentMergeViewer accesses its model by means of a content + * provider which must implement the IMergeViewerContentProvider + * interface. *

*

- * Clients may wish to use the standard concrete subclass TextMergeViewer, - * or define their own subclass. + * Clients may wish to use the standard concrete subclass + * TextMergeViewer, or define their own subclass. + *

* * @see IMergeViewerContentProvider * @see TextMergeViewer diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java index b287868df..e0ed70dd5 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java @@ -208,44 +208,51 @@ import org.eclipse.ui.texteditor.SourceViewerDecorationSupport; import com.ibm.icu.text.MessageFormat; /** - * A text merge viewer uses the RangeDifferencer to perform - * a textual, line-by-line comparison of two (or three) input documents. - * It is based on the ContentMergeViewer and uses TextViewers - * to implement the ancestor, left, and right content areas. + * A text merge viewer uses the RangeDifferencer to perform a + * textual, line-by-line comparison of two (or three) input documents. It is + * based on the ContentMergeViewer and uses + * TextViewers to implement the ancestor, left, and right content + * areas. *

- * In the three-way compare case ranges of differing lines are highlighted and framed - * with different colors to show whether the difference is an incoming, outgoing, or conflicting change. - * The TextMergeViewer supports the notion of a current "differing range" - * and provides toolbar buttons to navigate from one range to the next (or previous). + * In the three-way compare case ranges of differing lines are highlighted and + * framed with different colors to show whether the difference is an incoming, + * outgoing, or conflicting change. The TextMergeViewer supports + * the notion of a current "differing range" and provides toolbar buttons to + * navigate from one range to the next (or previous). *

- * If there is a current "differing range" and the underlying document is editable - * the TextMergeViewer enables actions in context menu and toolbar to - * copy a range from one side to the other side, thereby performing a merge operation. + * If there is a current "differing range" and the underlying document is + * editable the TextMergeViewer enables actions in context menu and + * toolbar to copy a range from one side to the other side, thereby performing a + * merge operation. *

* In addition to a line-by-line comparison the TextMergeViewer - * uses a token based compare on differing lines. - * The token compare is activated when navigating into - * a range of differing lines. At first the lines are selected as a block. - * When navigating into this block the token compare shows for every line - * the differing token by selecting them. + * uses a token based compare on differing lines. The token compare is activated + * when navigating into a range of differing lines. At first the lines are + * selected as a block. When navigating into this block the token compare shows + * for every line the differing token by selecting them. *

- * The TextMergeViewer's default token compare works on characters separated - * by whitespace. If a different strategy is needed (for example, Java tokens in - * a Java-aware merge viewer), clients can create their own token - * comparators by implementing the ITokenComparator interface and overriding the - * TextMergeViewer.createTokenComparator factory method). + * The TextMergeViewer's default token compare works on characters + * separated by whitespace. If a different strategy is needed (for example, Java + * tokens in a Java-aware merge viewer), clients can create their own token + * comparators by implementing the ITokenComparator interface and + * overriding the TextMergeViewer.createTokenComparator factory + * method). *

* Access to the TextMergeViewer's model is by means of an - * IMergeViewerContentProvider. Its getXContent methods must return - * either an IDocument, an IDocumentRange, or an IStreamContentAccessor. - * In the IDocumentRange case the TextMergeViewer - * works on a subrange of a document. In the IStreamContentAccessor case + * IMergeViewerContentProvider. Its getXContent + * methods must return either an IDocument, an + * IDocumentRange, or an IStreamContentAccessor. In + * the IDocumentRange case the TextMergeViewer works + * on a subrange of a document. In the IStreamContentAccessor case * a document is created internally and initialized from the stream. *

- * A TextMergeViewer can be used as is. However clients may subclass - * to customize the behavior. For example a MergeTextViewer for Java would override - * the configureTextViewer method to configure the TextViewer for Java source code, - * the createTokenComparator method to create a Java specific tokenizer. + * A TextMergeViewer can be used as is. However clients may + * subclass to customize the behavior. For example a + * MergeTextViewer for Java would override the + * configureTextViewer method to configure the + * TextViewer for Java source code, the + * createTokenComparator method to create a Java specific + * tokenizer. *

* In 3.5 a new API has been introduced to let clients provide their own source * viewers implementation with an option to configure them basing on a diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/IStructureCreator.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/IStructureCreator.java index 9451eef75..1e607f513 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/IStructureCreator.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/IStructureCreator.java @@ -20,6 +20,7 @@ package org.eclipse.compare.structuremergeviewer; * and to map a node of this structure back to the corresponding input object. *

* Structure creators are used in the following contexts: + *

* + *

* A IStructureCreator provides methods for rewriting the tree produced by the differencing * engine to support "smart" structural differencing. E.g. certain patterns of pairs of "addition" * and "deletion" nodes can be detected as renames and merged into a single node. -- cgit v1.2.3