diff options
author | Alexander Kurtakov | 2019-02-13 12:41:09 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-13 12:41:09 +0000 |
commit | 4466a92c1607ffafb97f447841920ac62148ce12 (patch) | |
tree | 6df9a096d0ae5dec3d108031ee9c8e9ef3b096a2 /bundles/org.eclipse.compare/compare/org/eclipse | |
parent | 7692475a2c0c12a45cbd7d862092b6e1b6b6c96a (diff) | |
download | eclipse.platform.team-4466a92c1607ffafb97f447841920ac62148ce12.tar.gz eclipse.platform.team-4466a92c1607ffafb97f447841920ac62148ce12.tar.xz eclipse.platform.team-4466a92c1607ffafb97f447841920ac62148ce12.zip |
Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool.
Change-Id: I077488664870277e1a7b4f8ab729c7ead1fcf5b0
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'bundles/org.eclipse.compare/compare/org/eclipse')
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 <code>ISavable.save</code> on them. + * Saves any unsaved changes. Subclasses must override to save any changes. This + * implementation tries to flush changes in all viewers by calling + * <code>ISavable.save</code> on them. * - * @param monitor an <code>IProgressMonitor</code> that the implementation of save may use to show progress - * @throws CoreException + * @param monitor an <code>IProgressMonitor</code> 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 <code>IStreamContentAccessor</code> * is needed. * <p> - * <p> * Clients may instantiate this class; it is not intended to be subclassed. * </p> * @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. * <p> * <code>ContentMergeViewer</code> + * </p> * <ul> - * <li>implements the overall layout and defines hooks so that subclasses - * can easily provide an implementation for a specific content type, + * <li>implements the overall layout and defines hooks so that subclasses can + * easily provide an implementation for a specific content type, * <li>implements the UI for making the areas resizable, - * <li>has an action for controlling whether the ancestor area is visible or not, + * <li>has an action for controlling whether the ancestor area is visible or + * not, * <li>has actions for copying one side of the input to the other side, - * <li>tracks the dirty state of the left and right sides and send out notification - * on state changes. + * <li>tracks the dirty state of the left and right sides and send out + * notification on state changes. * </ul> - * A <code>ContentMergeViewer</code> accesses its - * model by means of a content provider which must implement the - * <code>IMergeViewerContentProvider</code> interface. + * <p> + * A <code>ContentMergeViewer</code> accesses its model by means of a content + * provider which must implement the <code>IMergeViewerContentProvider</code> + * interface. * </p> * <p> - * Clients may wish to use the standard concrete subclass <code>TextMergeViewer</code>, - * or define their own subclass. + * Clients may wish to use the standard concrete subclass + * <code>TextMergeViewer</code>, or define their own subclass. + * </p> * * @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 <code>RangeDifferencer</code> to perform - * a textual, line-by-line comparison of two (or three) input documents. - * It is based on the <code>ContentMergeViewer</code> and uses <code>TextViewer</code>s - * to implement the ancestor, left, and right content areas. + * A text merge viewer uses the <code>RangeDifferencer</code> to perform a + * textual, line-by-line comparison of two (or three) input documents. It is + * based on the <code>ContentMergeViewer</code> and uses + * <code>TextViewer</code>s to implement the ancestor, left, and right content + * areas. * <p> - * 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 <code>TextMergeViewer</code> 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 <code>TextMergeViewer</code> supports + * the notion of a current "differing range" and provides toolbar buttons to + * navigate from one range to the next (or previous). * <p> - * If there is a current "differing range" and the underlying document is editable - * the <code>TextMergeViewer</code> 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 <code>TextMergeViewer</code> enables actions in context menu and + * toolbar to copy a range from one side to the other side, thereby performing a + * merge operation. * <p> * In addition to a line-by-line comparison the <code>TextMergeViewer</code> - * 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. * <p> - * The <code>TextMergeViewer</code>'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 <code>ITokenComparator</code> interface and overriding the - * <code>TextMergeViewer.createTokenComparator</code> factory method). + * The <code>TextMergeViewer</code>'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 <code>ITokenComparator</code> interface and + * overriding the <code>TextMergeViewer.createTokenComparator</code> factory + * method). * <p> * Access to the <code>TextMergeViewer</code>'s model is by means of an - * <code>IMergeViewerContentProvider</code>. Its <code>get<it>X</it></code>Content</code> methods must return - * either an <code>IDocument</code>, an <code>IDocumentRange</code>, or an <code>IStreamContentAccessor</code>. - * In the <code>IDocumentRange</code> case the <code>TextMergeViewer</code> - * works on a subrange of a document. In the <code>IStreamContentAccessor</code> case + * <code>IMergeViewerContentProvider</code>. Its <code>getXContent</code> + * methods must return either an <code>IDocument</code>, an + * <code>IDocumentRange</code>, or an <code>IStreamContentAccessor</code>. In + * the <code>IDocumentRange</code> case the <code>TextMergeViewer</code> works + * on a subrange of a document. In the <code>IStreamContentAccessor</code> case * a document is created internally and initialized from the stream. * <p> - * A <code>TextMergeViewer</code> can be used as is. However clients may subclass - * to customize the behavior. For example a <code>MergeTextViewer</code> for Java would override - * the <code>configureTextViewer</code> method to configure the <code>TextViewer</code> for Java source code, - * the <code>createTokenComparator</code> method to create a Java specific tokenizer. + * A <code>TextMergeViewer</code> can be used as is. However clients may + * subclass to customize the behavior. For example a + * <code>MergeTextViewer</code> for Java would override the + * <code>configureTextViewer</code> method to configure the + * <code>TextViewer</code> for Java source code, the + * <code>createTokenComparator</code> method to create a Java specific + * tokenizer. * <p> * 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. * <p> * Structure creators are used in the following contexts: + * </p> * <ul> * <li> * the <code>StructureDiffViewer</code> uses an <code>IStructureCreator</code> to @@ -32,6 +33,7 @@ package org.eclipse.compare.structuremergeviewer; * to map a path back to a range of characters in the textual representation. * </li> * </ul> + * <p> * A <code>IStructureCreator</code> 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. |