diff options
author | Alexander Kurtakov | 2019-02-15 13:25:00 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-15 13:25:00 +0000 |
commit | 5a188447f9f5c3d266de68fbb232a468cf9590e4 (patch) | |
tree | e92c7d9804eea083495c23c90111caf070bce015 | |
parent | 2936a95c7b1920862b7355b138dc9cf4cfa5725a (diff) | |
download | eclipse.platform.text-5a188447f9f5c3d266de68fbb232a468cf9590e4.tar.gz eclipse.platform.text-5a188447f9f5c3d266de68fbb232a468cf9590e4.tar.xz eclipse.platform.text-5a188447f9f5c3d266de68fbb232a468cf9590e4.zip |
Bug 543933 - Build javadocs with Java 11
Fix warnings catched by java 11 javadoc. (take 4)
Change-Id: I64da26cfb07bb1f02e18f87954b24ce93546316e
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
16 files changed, 208 insertions, 172 deletions
diff --git a/org.eclipse.text/src/org/eclipse/text/edits/TextEditVisitor.java b/org.eclipse.text/src/org/eclipse/text/edits/TextEditVisitor.java index 18ba1e3831f..7db11d27aa9 100644 --- a/org.eclipse.text/src/org/eclipse/text/edits/TextEditVisitor.java +++ b/org.eclipse.text/src/org/eclipse/text/edits/TextEditVisitor.java @@ -16,19 +16,20 @@ package org.eclipse.text.edits; /** * A visitor for text edits. * <p> - * For each different concrete text edit type <it>T</it> there is a method: + * For each different concrete text edit type <i>T</i> there is a method: + * </p> * <ul> - * <li><code>public boolean visit(<it>T</it> node)</code> - Visits the given edit to + * <li><code>public boolean visit(<i>T</i> node)</code> - Visits the given edit to * perform some arbitrary operation. If <code>true </code> is returned, the given edit's * child edits will be visited next; however, if <code>false</code> is returned, the * given edit's child edits will not be visited. The default implementation provided by - * this class calls a generic method <code>visitNode(<it>TextEdit</it> node)</code>. + * this class calls a generic method <code>visitNode(<i>TextEdit</i> node)</code>. * Subclasses may reimplement these method as needed.</li> * </ul> - * </p> * <p> * In addition, there are methods for visiting text edits in the * abstract, regardless of node type: + * </p> * <ul> * <li><code>public void preVisit(TextEdit edit)</code> - Visits * the given edit to perform some arbitrary operation. @@ -44,7 +45,6 @@ package org.eclipse.text.edits; * The default implementation of this method does nothing. * Subclasses may reimplement this method as needed.</li> * </ul> - * </p> * <p> * For edits with children, the child nodes are visited in increasing order. * </p> diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java index 1b54be5e787..07f475f8668 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java @@ -17,17 +17,16 @@ import org.eclipse.core.runtime.IPath; /** - * This class gets the location for a given - * object. + * This class gets the location for a given object. * <p> - * In order to provided backward compatibility for clients of - * <code>ILocationProvider</code>, extension interfaces are used to provide a means - * of evolution. The following extension interfaces exist: + * In order to provided backward compatibility for clients of <code>ILocationProvider</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> * <ul> - * <li>{@link org.eclipse.ui.editors.text.ILocationProviderExtension} since version 3.3 - * allowing to get the location as <code>URI</code>.</li> + * <li>{@link org.eclipse.ui.editors.text.ILocationProviderExtension} since version 3.3 allowing to + * get the location as <code>URI</code>.</li> * </ul> - * </p> * * @see org.eclipse.ui.editors.text.ILocationProviderExtension * @since 3.0 diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java index ca4abb5fa3f..a2261760bb0 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java @@ -51,25 +51,25 @@ import org.eclipse.ui.editors.text.EditorsUI; /** - * Abstract implementation of a marker-based annotation model. + * Abstract implementation of a marker-based annotation model. * <p> - * Markers are provided by an underlying source (a subclass responsibility). - * Markers whose textual range gets deleted during text editing are removed - * from the model on save. The {@link #updateMarkers(IDocument)} method can be used - * to force the model to update the source's markers with any changes to their - * locations due to edits. Clients can register a {@link org.eclipse.ui.texteditor.IMarkerUpdater} - * objects in order to define the process of marker updating. Registration can be done - * using the <code>"org.eclipse.ui.markerUpdaters"</code> extension point. + * Markers are provided by an underlying source (a subclass responsibility). Markers whose textual + * range gets deleted during text editing are removed from the model on save. The + * {@link #updateMarkers(IDocument)} method can be used to force the model to update the source's + * markers with any changes to their locations due to edits. Clients can register a + * {@link org.eclipse.ui.texteditor.IMarkerUpdater} objects in order to define the process of marker + * updating. Registration can be done using the <code>"org.eclipse.ui.markerUpdaters"</code> + * extension point. * </p> * <p> * Subclasses must implement the following methods: + * </p> * <ul> - * <li><code>retrieveMarkers</code></li> - * <li><code>isAcceptable</code></li> - * <li><code>deleteMarkers</code></li> - * <li><code>listenToMarkerChanges</code></li> + * <li><code>retrieveMarkers</code></li> + * <li><code>isAcceptable</code></li> + * <li><code>deleteMarkers</code></li> + * <li><code>listenToMarkerChanges</code></li> * </ul> - * </p> */ public abstract class AbstractMarkerAnnotationModel extends AnnotationModel implements IPersistableAnnotationModel { diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java index 4d981dd07e6..988415a4d41 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java @@ -47,20 +47,21 @@ import org.eclipse.ui.ide.undo.CreateMarkersOperation; /** - * Action for creating a marker of a specified type for the editor's - * input element based on the editor's selection. If required, the - * action asks the user to provide a marker label. The action is initially - * associated with a text editor via the constructor, but that can be - * subsequently changed using <code>setEditor</code>. + * Action for creating a marker of a specified type for the editor's input element based on the + * editor's selection. If required, the action asks the user to provide a marker label. The action + * is initially associated with a text editor via the constructor, but that can be subsequently + * changed using <code>setEditor</code>. * <p> - * The following keys, prepended by the given option prefix, - * are used for retrieving resources from the given bundle: + * The following keys, prepended by the given option prefix, are used for retrieving resources from + * the given bundle: + * </p> * <ul> - * <li><code>"dialog.title"</code> - the input dialog's title</li> - * <li><code>"dialog.message"</code> - the input dialog's message</li> - * <li><code>"error.dialog.title"</code> - the error dialog's title</li> - * <li><code>"error.dialog.message"</code> - the error dialog's message</li> + * <li><code>"dialog.title"</code> - the input dialog's title</li> + * <li><code>"dialog.message"</code> - the input dialog's message</li> + * <li><code>"error.dialog.title"</code> - the error dialog's title</li> + * <li><code>"error.dialog.message"</code> - the error dialog's message</li> * </ul> + * <p> * This class may be instantiated but is not intended to be subclassed. * </p> * diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChangeEncodingAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChangeEncodingAction.java index 18822ab46d9..1d467fd985a 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChangeEncodingAction.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChangeEncodingAction.java @@ -40,14 +40,15 @@ import org.eclipse.ui.ide.dialogs.ResourceEncodingFieldEditor; import org.eclipse.ui.editors.text.IEncodingSupport; /** - * Action for changing the encoding of the editor's - * input element. + * Action for changing the encoding of the editor's input element. * <p> - * The following keys, prepended by the given option prefix, - * are used for retrieving resources from the given bundle: + * The following keys, prepended by the given option prefix, are used for retrieving resources from + * the given bundle: + * </p> * <ul> - * <li><code>"dialog.title"</code> - the input dialog's title</li> + * <li><code>"dialog.title"</code> - the input dialog's title</li> * </ul> + * <p> * This class may be instantiated but is not intended to be subclassed. * </p> * diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AnnotationPreference.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AnnotationPreference.java index dd9a75b09cf..cc9b923cb1c 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AnnotationPreference.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AnnotationPreference.java @@ -40,7 +40,7 @@ import org.eclipse.ui.internal.texteditor.TextEditorPlugin; * that can be used to obtain the currently set value from an * <code>IPreferenceStore</code>. * </p> - * <h3>The following annotation preferences are covered:</h4> + * <h3>The following annotation preferences are covered:</h3> * <h4>Display Preferences controlling how and where annotations are shown</h4> * <ul> * <li>as text background highlighting (and respective preference key),</li> @@ -48,11 +48,11 @@ import org.eclipse.ui.internal.texteditor.TextEditorPlugin; * <li>on the overview ruler (and respective preference key),</li> * <li>on the overview ruler header,</li> * <li>on the vertical ruler (and respective preference key),</li> - * </li> * </ul> * <h4>Additional Display Preferences</h4> * <ul> - * <li>the base color for annotations of this type (and respective preference key), + * <li>the base color for annotations of this type (and respective preference + * key), * <li>the style of text decorations that are drawn (and respective preference * key),</li> * <li>the annotation image provider,</li> diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/BasicTextEditorActionContributor.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/BasicTextEditorActionContributor.java index e65db957e12..173b3da4210 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/BasicTextEditorActionContributor.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/BasicTextEditorActionContributor.java @@ -35,21 +35,26 @@ import org.eclipse.ui.part.EditorActionBarContributor; /** - * Manages the installation and removal of global actions for - * the same type of editors. + * Manages the installation and removal of global actions for the same type of + * editors. * <p> - * If instantiated and used as-is, this contributor connects to all of the workbench defined - * global editor actions the corresponding actions of the current editor. It also adds addition - * actions for searching and navigation (go to line) as well as a set of status fields.</p> + * If instantiated and used as-is, this contributor connects to all of the + * workbench defined global editor actions the corresponding actions of the + * current editor. It also adds addition actions for searching and navigation + * (go to line) as well as a set of status fields. + * </p> * <p> * Subclasses may override the following methods: + * </p> * <ul> - * <li><code>contributeToMenu</code> - extend to contribute to menu</li> - * <li><code>contributeToToolBar</code> - reimplement to contribute to tool bar</li> - * <li><code>contributeToStatusLine</code> - reimplement to contribute to status line</li> - * <li><code>setActiveEditor</code> - extend to react to editor changes</li> + * <li><code>contributeToMenu</code> - extend to contribute to menu</li> + * <li><code>contributeToToolBar</code> - reimplement to contribute to tool + * bar</li> + * <li><code>contributeToStatusLine</code> - reimplement to contribute to status + * line</li> + * <li><code>setActiveEditor</code> - extend to react to editor changes</li> * </ul> - * </p> + * * @see org.eclipse.ui.texteditor.ITextEditorActionConstants */ public class BasicTextEditorActionContributor extends EditorActionBarContributor { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java index c55d21a9672..4e90be89e3b 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/GotoLineAction.java @@ -40,19 +40,22 @@ import org.eclipse.ui.internal.texteditor.TextEditorPlugin; /** - * Action for jumping to a particular line in the editor's text viewer. The user is requested to - * enter the line number into an input dialog. The action is initially associated with a text editor - * via the constructor, but that can be subsequently changed using <code>setEditor</code>. + * Action for jumping to a particular line in the editor's text viewer. The user + * is requested to enter the line number into an input dialog. The action is + * initially associated with a text editor via the constructor, but that can be + * subsequently changed using <code>setEditor</code>. * <p> - * The following keys, prepended by the given option prefix, are used for retrieving resources from - * the given bundle: + * The following keys, prepended by the given option prefix, are used for + * retrieving resources from the given bundle: + * </p> * <ul> - * <li><code>"dialog.invalid_range"</code> - to indicate an invalid line number</li> - * <li><code>"dialog.invalid_input"</code> - to indicate an invalid line number format</li> + * <li><code>"dialog.invalid_range"</code> - to indicate an invalid line + * number</li> + * <li><code>"dialog.invalid_input"</code> - to indicate an invalid line number + * format</li> * <li><code>"dialog.title"</code> - the input dialog's title</li> * <li><code>"dialog.message"</code> - the input dialog's message</li> * </ul> - * </p> * <p> * This class may be instantiated; it is not intended to be subclassed. * </p> diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProvider.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProvider.java index 297f879300e..6f0343e2e31 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProvider.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IDocumentProvider.java @@ -20,42 +20,48 @@ import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.source.IAnnotationModel; /** - * A document provider maps between domain elements and documents. A document provider has the - * following responsibilities: + * A document provider maps between domain elements and documents. A document + * provider has the following responsibilities: * <ul> * <li>create an annotation model of a domain model element - * <li>create and manage a textual representation, i.e., a document, of a domain model element - * <li>create and save the content of domain model elements based on given documents - * <li>update the documents this document provider manages for domain model elements to changes - * directly applied to those domain model elements - * <li>notify all element state listeners about changes directly applied to domain model elements - * this document provider manages a document for, i.e. the document provider must know which changes - * of a domain model element are to be interpreted as element moves, deletes, etc. + * <li>create and manage a textual representation, i.e., a document, of a domain + * model element + * <li>create and save the content of domain model elements based on given + * documents + * <li>update the documents this document provider manages for domain model + * elements to changes directly applied to those domain model elements + * <li>notify all element state listeners about changes directly applied to + * domain model elements this document provider manages a document for, i.e. the + * document provider must know which changes of a domain model element are to be + * interpreted as element moves, deletes, etc. * </ul> - * Text editors use document providers to bridge the gap between their input elements and the - * documents they work on. A single document provider may be shared between multiple editors; the - * methods take the editors' input elements as a parameter. + * Text editors use document providers to bridge the gap between their input + * elements and the documents they work on. A single document provider may be + * shared between multiple editors; the methods take the editors' input elements + * as a parameter. * <p> - * This interface may be implemented by clients; or subclass the standard abstract base class - * <code>AbstractDocumentProvider</code>. + * This interface may be implemented by clients; or subclass the standard + * abstract base class <code>AbstractDocumentProvider</code>. * </p> * <p> - * In order to provided backward compatibility for clients of <code>IDocumentProvider</code>, - * extension interfaces are used to provide a means of evolution. The following extension interfaces - * exist: + * In order to provided backward compatibility for clients of + * <code>IDocumentProvider</code>, extension interfaces are used to provide a + * means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension} since version 2.0 introducing - * state validation, extended read-only handling and synchronization.</li> - * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension2} since version 2.1 introducing - * adding support for a global progress monitor.</li> - * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension3} since version 3.0 adding - * a predicate for querying synchronization state.</li> - * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension4} since version 3.1 adding - * a predicate for querying an element's the content description.</li> - * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension5} since version 3.2 adding - * the ability to detect a non-synchronized exception.</li> + * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension} since + * version 2.0 introducing state validation, extended read-only handling and + * synchronization.</li> + * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension2} since + * version 2.1 introducing adding support for a global progress monitor.</li> + * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension3} since + * version 3.0 adding a predicate for querying synchronization state.</li> + * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension4} since + * version 3.1 adding a predicate for querying an element's the content + * description.</li> + * <li>{@link org.eclipse.ui.texteditor.IDocumentProviderExtension5} since + * version 3.2 adding the ability to detect a non-synchronized exception.</li> * </ul> - * </p> * * @see org.eclipse.jface.text.IDocument * @see org.eclipse.ui.texteditor.AbstractDocumentProvider diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IElementStateListener.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IElementStateListener.java index 424724a3673..8441189a097 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IElementStateListener.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IElementStateListener.java @@ -18,23 +18,24 @@ package org.eclipse.ui.texteditor; * Interface for parties interested in standardized element changes. These * changes are: * <ul> - * <li> dirty state changes - * <li> content replacements - * <li> moves - * <li> deletions + * <li>dirty state changes + * <li>content replacements + * <li>moves + * <li>deletions * </ul> - * The notifications sent to the element state listeners inform about those standardized, - * abstract changes. The concrete change applied might differ from the one the listeners - * are notified about, but should be interpreted as the one the listeners receive. + * The notifications sent to the element state listeners inform about those + * standardized, abstract changes. The concrete change applied might differ from + * the one the listeners are notified about, but should be interpreted as the + * one the listeners receive. * <p> - * In order to provided backward compatibility for clients of <code>IElementStateListener</code>, - * extension interfaces are used to provide a means of evolution. The following extension interface - * exists: + * In order to provided backward compatibility for clients of + * <code>IElementStateListener</code>, extension interfaces are used to provide + * a means of evolution. The following extension interface exists: + * </p> * <ul> - * <li>{@link org.eclipse.ui.texteditor.IElementStateListenerExtension} since version 2.0 introducing - * state validation events.</li> + * <li>{@link org.eclipse.ui.texteditor.IElementStateListenerExtension} since + * version 2.0 introducing state validation events.</li> * </ul> - * </p> * * @see org.eclipse.ui.texteditor.IElementStateListenerExtension */ diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IStatusField.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IStatusField.java index 9e50032f333..ea53db8edbc 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IStatusField.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/IStatusField.java @@ -23,13 +23,13 @@ import org.eclipse.swt.graphics.Image; * workbench's status line if the contributing editor is active. * <p> * In order to provided backward compatibility for clients of - * <code>IStatusField</code>, extension interfaces are used to provide a - * means of evolution. The following extension interface exists: + * <code>IStatusField</code>, extension interfaces are used to provide a means + * of evolution. The following extension interface exists: + * </p> * <ul> - * <li>{@link org.eclipse.ui.texteditor.IStatusFieldExtension} since - * version 3.0 introducing error text, tooltips and visibility control.</li> + * <li>{@link org.eclipse.ui.texteditor.IStatusFieldExtension} since version 3.0 + * introducing error text, tooltips and visibility control.</li> * </ul> - * </p> * * @see org.eclipse.ui.texteditor.IStatusFieldExtension * @since 2.0 diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditor.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditor.java index f3867eabe0f..f894bc5b248 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditor.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditor.java @@ -23,34 +23,39 @@ import org.eclipse.ui.IEditorPart; /** * Interface to a text editor. This interface defines functional extensions to - * <code>IEditorPart</code> as well as the configuration capabilities of a text editor. + * <code>IEditorPart</code> as well as the configuration capabilities of a text + * editor. * <p> - * Text editors are configured with an <code>IDocumentProvider</code> which delivers a textual - * presentation (<code>IDocument</code>) of the editor's input. The editor works on the document and - * forwards all input element related calls, such as <code>save</code>, to the document provider. - * The provider also delivers the input's annotation model which is used by the editor's vertical - * ruler. + * Text editors are configured with an <code>IDocumentProvider</code> which + * delivers a textual presentation (<code>IDocument</code>) of the editor's + * input. The editor works on the document and forwards all input element + * related calls, such as <code>save</code>, to the document provider. The + * provider also delivers the input's annotation model which is used by the + * editor's vertical ruler. * </p> * <p> - * Clients may implement this interface from scratch, but the recommended way is to subclass the - * abstract base class <code>AbstractTextEditor</code>. + * Clients may implement this interface from scratch, but the recommended way is + * to subclass the abstract base class <code>AbstractTextEditor</code>. * </p> * <p> - * In order to provided backward compatibility for clients of <code>ITextEditor</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provided backward compatibility for clients of + * <code>ITextEditor</code>, extension interfaces are used to provide a means of + * evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension} since version 2.0 introducing status - * fields, read-only state and ruler context menu listeners.</li> - * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension2} since version 2.1 introducing - * modifiable state for the editor input and validate state handling.</li> - * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension3} since version 3.0 adding input state - * and change information control.</li> - * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension4} since version 3.2 adding annotation - * navigation and revision information display.</li> - * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension5} since version 3.5 adding block - * selection mode.</li> + * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension} since version 2.0 + * introducing status fields, read-only state and ruler context menu + * listeners.</li> + * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension2} since version 2.1 + * introducing modifiable state for the editor input and validate state + * handling.</li> + * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension3} since version 3.0 + * adding input state and change information control.</li> + * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension4} since version 3.2 + * adding annotation navigation and revision information display.</li> + * <li>{@link org.eclipse.ui.texteditor.ITextEditorExtension5} since version 3.5 + * adding block selection mode.</li> * </ul> - * </p> * * @see org.eclipse.ui.texteditor.IDocumentProvider * @see org.eclipse.jface.text.source.IAnnotationModel diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/InsertLineAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/InsertLineAction.java index 3b1605e1889..05785b44ad8 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/InsertLineAction.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/InsertLineAction.java @@ -25,25 +25,30 @@ import org.eclipse.jface.text.Position; import org.eclipse.jface.text.source.ISourceViewer; /** - * This action implements smart return. - * Instead of breaking the line where we are, we do the following: - * <p><b>Smart Enter</b> + * This action implements smart return. Instead of breaking the line where we + * are, we do the following: + * <p> + * <b>Smart Enter</b> + * </p> * <ul> - * <li> if the caret is on a line containing any non-whitespace, a line is inserted below the - * current one and the caret moved to it,</li> - * <li> if the caret is on a whitespace-only line, a line is inserted below the current line, - * but the caret stays in its position.</li> + * <li>if the caret is on a line containing any non-whitespace, a line is + * inserted below the current one and the caret moved to it,</li> + * <li>if the caret is on a whitespace-only line, a line is inserted below the + * current line, but the caret stays in its position.</li> * </ul> + * <p> + * <b>Smart Enter Inverse</b> * </p> - * <p><b>Smart Enter Inverse</b> * <ul> - * <li> if the caret is on a line containing any non-whitespace, we insert a line above the - * current one and move the caret to it (i.e. it stays at the same offset in the widget),</li> - * <li> if the caret is on a whitespace-only line, a line is inserted above the current line, - * but the caret stays in its logical position (i.e., it gets shifted one line down in the - * document, but keeps its position relative to the content following the caret).</li> + * <li>if the caret is on a line containing any non-whitespace, we insert a line + * above the current one and move the caret to it (i.e. it stays at the same + * offset in the widget),</li> + * <li>if the caret is on a whitespace-only line, a line is inserted above the + * current line, but the caret stays in its logical position (i.e., it gets + * shifted one line down in the document, but keeps its position relative to the + * content following the caret).</li> * </ul> - * </p> + * * @since 3.0 */ public class InsertLineAction extends TextEditorAction { 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 d1f93b99374..87d43bdaf1f 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 @@ -68,16 +68,17 @@ import org.eclipse.jface.text.source.MatchingCharacterPainter; * <p> * <code>SourceViewerDecorationSupport</code> can draw the following * decorations: + * </p> * <ul> * <li>matching character highlighting,</li> * <li>current line highlighting,</li> * <li>print margin, and</li> * <li>annotations.</li> * </ul> + * <p> * Annotations are managed for the overview ruler and also drawn onto the text - * widget by an - * {@link org.eclipse.jface.text.source.AnnotationPainter AnnotationPainter} - * instance. + * widget by an {@link org.eclipse.jface.text.source.AnnotationPainter + * AnnotationPainter} instance. * </p> * <p> * Subclasses may add decorations but should adhere to the lifecyle described diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/ITemplatesPage.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/ITemplatesPage.java index 413345d9107..8c68c0d660b 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/ITemplatesPage.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/ITemplatesPage.java @@ -17,19 +17,22 @@ import org.eclipse.ui.part.IPageBookViewPage; /** - * Interface for a templates page. This interface defines the minimum requirement for a page within - * the {@link TemplatesView}. + * Interface for a templates page. This interface defines the minimum + * requirement for a page within the {@link TemplatesView}. * <p> - * In order to provided backward compatibility for clients of <code>ITemplatesPage</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provided backward compatibility for clients of + * <code>ITemplatesPage</code>, extension interfaces are used to provide a means + * of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.ui.texteditor.templates.ITemplatesPageExtension} since version 3.6 - * introducing access to the currently selected items and the template store of the page.</li> + * <li>{@link org.eclipse.ui.texteditor.templates.ITemplatesPageExtension} since + * version 3.6 introducing access to the currently selected items and the + * template store of the page.</li> * </ul> - * </p> * <p> * Clients can either implement this interface directly or subclass the * {@link AbstractTemplatesPage}. + * </p> * * @see org.eclipse.ui.texteditor.templates.ITemplatesPageExtension * @see TemplatesView diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesView.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesView.java index c9006cbf55d..6814e3bbf87 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesView.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesView.java @@ -35,12 +35,13 @@ import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds; /** - * The Templates view.hosts {@link ITemplatesPage}s that shows the templates for the currently - * active editor part. + * The Templates view.hosts {@link ITemplatesPage}s that shows the templates for + * the currently active editor part. * <p> - * When this view notices an editor being activated, it uses the Eclipse adapter mechanism to get - * its {@link ITemplatesPage}. Hence, editors that want to provide a templates page need to provide - * such an adapter: + * When this view notices an editor being activated, it uses the Eclipse adapter + * mechanism to get its {@link ITemplatesPage}. Hence, editors that want to + * provide a templates page need to provide such an adapter: + * </p> * * <pre> * Object getAdapter() { @@ -53,11 +54,14 @@ import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds; * } * ... * } - * </pre></p> + * </pre> * <p> - * <strong>Note:</strong> This plug-in does not contribute this view. Clients that want to - * use this view must check whether it is available and if not, contribute this view via - * extension point using the specified view Id {@link #ID}: + * <strong>Note:</strong> This plug-in does not contribute this view. Clients + * that want to use this view must check whether it is available and if not, + * contribute this view via extension point using the specified view Id + * {@link #ID}: + * </p> + * * <pre> * <extension * point="org.eclipse.ui.views"> @@ -70,16 +74,18 @@ import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds; * </view> * </extension> * </pre> + * * The <code>templates.png</code> icon can be copied from this plug-in. - * </p> - * If the editor supports a templates page, the editor instantiates and configures the page, and - * returns it. This page is then added to this Templates view and immediately made the current page - * (the Templates view needs not to be visible). If the - * editor does not support a templates page, the Templates view shows a special default page which - * makes it clear to the user that no templates are available. When the Templates view notices - * a different editor being activated, it flips to the editor's corresponding templates page. When - * the templates view notices an editor being closed, it may destroy the editor's corresponding - * templates page. + * <p> + * If the editor supports a templates page, the editor instantiates and + * configures the page, and returns it. This page is then added to this + * Templates view and immediately made the current page (the Templates view + * needs not to be visible). If the editor does not support a templates page, + * the Templates view shows a special default page which makes it clear to the + * user that no templates are available. When the Templates view notices a + * different editor being activated, it flips to the editor's corresponding + * templates page. When the templates view notices an editor being closed, it + * may destroy the editor's corresponding templates page. * </p> * <p> * This class is not intended to be instantiated or subclassed by clients. |