diff options
author | Alexander Kurtakov | 2019-02-14 21:09:58 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-14 21:57:20 +0000 |
commit | 2936a95c7b1920862b7355b138dc9cf4cfa5725a (patch) | |
tree | b4ac04beca2915afe7bde41faff53febcf78fae1 | |
parent | c40e4685598064f2be87b659f2c60e094d63ca07 (diff) | |
download | eclipse.platform.text-2936a95c7b1920862b7355b138dc9cf4cfa5725a.tar.gz eclipse.platform.text-2936a95c7b1920862b7355b138dc9cf4cfa5725a.tar.xz eclipse.platform.text-2936a95c7b1920862b7355b138dc9cf4cfa5725a.zip |
Bug 543933 - Build javadocs with Java 11I20190215-0630I20190215-0055I20190214-1800
Fix warnings catched by java 11 javadoc. (take 3)
Change-Id: I6e7fd7d2f60b67dfdfe31e89d80c871cfd6c443f
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
43 files changed, 516 insertions, 545 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/ComboContentAssistSubjectAdapter.java b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/ComboContentAssistSubjectAdapter.java index fdeeab997c1..cb41b99dc65 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/ComboContentAssistSubjectAdapter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/ComboContentAssistSubjectAdapter.java @@ -36,18 +36,18 @@ import org.eclipse.jface.text.IDocument; /** - * Adapts a {@link org.eclipse.swt.widgets.Combo} to a {@link org.eclipse.jface.contentassist.IContentAssistSubjectControl}. + * Adapts a {@link org.eclipse.swt.widgets.Combo} to a + * {@link org.eclipse.jface.contentassist.IContentAssistSubjectControl}. * * <p> - * Known issues: - * <ul> - * <li>https://bugs.eclipse.org/bugs/show_bug.cgi?id=50121 - * = > Combo doesn't get Arrow_up/Down keys on GTK</li> + * Known issues: + * </p> + * <ul> + * <li>https://bugs.eclipse.org/bugs/show_bug.cgi?id=50121 = > Combo doesn't get Arrow_up/Down + * keys on GTK</li> * - * <li>https://bugs.eclipse.org/bugs/show_bug.cgi?id=50123 - * = > Combo broken on MacOS X</li> - * </ul> - * </p> + * <li>https://bugs.eclipse.org/bugs/show_bug.cgi?id=50123 = > Combo broken on MacOS X</li> + * </ul> * * @since 3.0 * @deprecated As of 3.2, replaced by Platform UI's field assist support diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultInformationControl.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultInformationControl.java index c03e65335bc..6cea829c7ba 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultInformationControl.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultInformationControl.java @@ -35,9 +35,10 @@ import org.eclipse.jface.util.Geometry; /** * Default implementation of {@link org.eclipse.jface.text.IInformationControl}. * <p> - * Displays textual information in a {@link org.eclipse.swt.custom.StyledText} - * widget. Before displaying, the information set to this information control is - * processed by an <code>IInformationPresenter</code>. + * Displays textual information in a {@link org.eclipse.swt.custom.StyledText} widget. Before + * displaying, the information set to this information control is processed by an + * <code>IInformationPresenter</code>. + * </p> * * @since 2.0 */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IBlockTextSelection.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IBlockTextSelection.java index 6cb12e4973e..5e931d2a83e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IBlockTextSelection.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IBlockTextSelection.java @@ -20,14 +20,14 @@ package org.eclipse.jface.text; * character ranges covered by a column selection is influenced by the used font and tabulator * width. Using column selections with proportional fonts may render unexpected results. * - * <h5><a name="virtual">Virtual Spaces</a></h5> - * The {@linkplain #getStartColumn() start column} and {@linkplain #getEndColumn() end column} may - * refer to "virtual offsets" in the white space beyond the end of the line. Such an - * offset can be realized by inserting a space for each missing character. + * <h5>Virtual Spaces</h5> The {@linkplain #getStartColumn() start column} and + * {@linkplain #getEndColumn() end column} may refer to "virtual offsets" in the white + * space beyond the end of the line. Such an offset can be realized by inserting a space for each + * missing character. * <p> - * The {@linkplain ITextSelection#getOffset() offset} and - * {@linkplain ITextSelection#getLength() length} of an {@link IBlockTextSelection} refer to the - * smallest non-virtual range that comprises the entire rectangular selection. + * The {@linkplain ITextSelection#getOffset() offset} and {@linkplain ITextSelection#getLength() + * length} of an {@link IBlockTextSelection} refer to the smallest non-virtual range that comprises + * the entire rectangular selection. * </p> * <p> * Clients may implement this interface or use the default implementation provided by diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java index bb0ba8f976b..dd64c3467b1 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java @@ -18,17 +18,17 @@ package org.eclipse.jface.text; import org.eclipse.swt.events.VerifyEvent; /** - * Implementers can register with a text viewer and receive - * <code>VerifyEvent</code>s before the text viewer they are registered with. - * If the event consumer marks events as processed by turning their - * <code>doit</code> field to <code>false</code> the text viewer - * subsequently ignores them.</p> + * Implementers can register with a text viewer and receive <code>VerifyEvent</code>s before the + * text viewer they are registered with. If the event consumer marks events as processed by turning + * their <code>doit</code> field to <code>false</code> the text viewer subsequently ignores them. * <p> - * Clients may implement this interface.</p> + * Clients may implement this interface. + * </p> * <p> - * {@link org.eclipse.jface.text.ITextViewerExtension2}allows clients to manage - * the {@link org.eclipse.swt.events.VerifyListener}s of a text viewer. This - * makes <code>IEventConsumer</code> obsolete.</p> + * {@link org.eclipse.jface.text.ITextViewerExtension2}allows clients to manage the + * {@link org.eclipse.swt.events.VerifyListener}s of a text viewer. This makes + * <code>IEventConsumer</code> obsolete. + * </p> * * @see org.eclipse.jface.text.ITextViewer * @see org.eclipse.jface.text.ITextViewerExtension2 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IInformationControlExtension5.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IInformationControlExtension5.java index a9bd6923968..e4c1223f023 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IInformationControlExtension5.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IInformationControlExtension5.java @@ -21,8 +21,7 @@ import org.eclipse.jface.resource.JFaceResources; /** - * Extension interface for {@link org.eclipse.jface.text.IInformationControl}. - * Adds API + * Extension interface for {@link org.eclipse.jface.text.IInformationControl}. Adds API * <ul> * <li>to test the visibility of the control,</li> * <li>to test whether another control is a child of the information control,</li> @@ -32,19 +31,18 @@ import org.eclipse.jface.resource.JFaceResources; * * <p> * <b>Important:</b> Enriching this information control only works properly if - * {@link IInformationControl#isFocusControl()} is implemented like this (<code>fShell</code> - * is the control's shell): + * {@link IInformationControl#isFocusControl()} is implemented like this (<code>fShell</code> is the + * control's shell): + * </p> * * <pre> * return fShell.getDisplay().getActiveShell() == fShell * </pre> - * Likewise, - * {@link IInformationControl#addFocusListener(org.eclipse.swt.events.FocusListener)} - * should install listeners for {@link SWT#Activate} and {@link SWT#Deactivate} - * on the shell and forward events to the focus listeners. Clients are - * encouraged to subclass {@link AbstractInformationControl}, which does this - * for free. - * </p> + * + * Likewise, {@link IInformationControl#addFocusListener(org.eclipse.swt.events.FocusListener)} + * should install listeners for {@link SWT#Activate} and {@link SWT#Deactivate} on the shell and + * forward events to the focus listeners. Clients are encouraged to subclass + * {@link AbstractInformationControl}, which does this for free. * * @see org.eclipse.jface.text.IInformationControl * @since 3.4 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java index 25e70819f63..3677d7b074d 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java @@ -16,31 +16,31 @@ package org.eclipse.jface.text; /** - * A painter is responsible for creating, managing, updating, and removing - * visual decorations on an <code>ITextViewer</code>'s text widget. Examples - * are the highlighting of the caret line, the print margin, or the highlighting - * of matching peer characters such as pairs of brackets.</p> + * A painter is responsible for creating, managing, updating, and removing visual decorations on an + * <code>ITextViewer</code>'s text widget. Examples are the highlighting of the caret line, the + * print margin, or the highlighting of matching peer characters such as pairs of brackets. * <p> - * Clients may implement this interface.</p> + * Clients may implement this interface. + * </p> * <p> - * Painters should be registered with a - * {@link org.eclipse.jface.text.PaintManager}. The paint manager tracks - * several classes of events issued by an <code>ITextViewer</code> and reacts - * by appropriately invoking the registered painters. + * Painters should be registered with a {@link org.eclipse.jface.text.PaintManager}. The paint + * manager tracks several classes of events issued by an <code>ITextViewer</code> and reacts by + * appropriately invoking the registered painters. + * </p> * <p> - * Painters are either active or inactive. Usually, painters are initially - * inactive and are activated by the first call to their <code>paint</code> - * method. Painters can be deactivated by calling <code>deactivate</code>. - * Inactive painter can be reactivated by calling <code>paint</code>. - * <p> - * Painters usually have to manage state information. E.g., a painter painting a - * caret line highlight must redraw the previous and the actual caret line in - * the advent of a change of the caret position. This state information must be - * adapted to changes of the viewer's content. In order to support this common - * scenario, the <code>PaintManager</code> gives a painter access to a - * {@link org.eclipse.jface.text.IPaintPositionManager}. The painter can use - * this updater to manage its state information. + * Painters are either active or inactive. Usually, painters are initially inactive and are + * activated by the first call to their <code>paint</code> method. Painters can be deactivated by + * calling <code>deactivate</code>. Inactive painter can be reactivated by calling + * <code>paint</code>. + * </p> * <p> + * Painters usually have to manage state information. E.g., a painter painting a caret line + * highlight must redraw the previous and the actual caret line in the advent of a change of the + * caret position. This state information must be adapted to changes of the viewer's content. In + * order to support this common scenario, the <code>PaintManager</code> gives a painter access to a + * {@link org.eclipse.jface.text.IPaintPositionManager}. The painter can use this updater to manage + * its state information. + * </p> * * @see org.eclipse.jface.text.PaintManager * @see org.eclipse.jface.text.IPaintPositionManager diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextHover.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextHover.java index d618c8d156c..5824e525fdb 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextHover.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextHover.java @@ -14,25 +14,25 @@ package org.eclipse.jface.text; /** - * Computes the information to be shown in a hover popup which appears on top of - * the text viewer's text widget when a hover event occurs. If the text hover - * does not provide information no hover popup is shown. Any implementer of this - * interface must be capable of operating in a non-UI thread. + * Computes the information to be shown in a hover popup which appears on top of the text viewer's + * text widget when a hover event occurs. If the text hover does not provide information no hover + * popup is shown. Any implementer of this interface must be capable of operating in a non-UI + * thread. * <p> * - * In order to provide backward compatibility for clients of - * <code>ITextHover</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>ITextHover</code>, extension + * interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.ITextHoverExtension} since version 3.0 - * allowing a text hover to provide a creator for the hover control. This allows - * for sophisticated hovers in a way that information computed by the hover can - * be displayed in the best possible form.</li> - * <li>{@link org.eclipse.jface.text.ITextHoverExtension2} since version 3.4 - * allowing a text hover to return hover-specific information objects.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.ITextHoverExtension} since version 3.0 allowing a text hover to + * provide a creator for the hover control. This allows for sophisticated hovers in a way that + * information computed by the hover can be displayed in the best possible form.</li> + * <li>{@link org.eclipse.jface.text.ITextHoverExtension2} since version 3.4 allowing a text hover + * to return hover-specific information objects.</li> + * </ul> * <p> - * Clients may implement this interface.</p> + * Clients may implement this interface. + * </p> * * @see org.eclipse.jface.text.ITextHoverExtension * @see org.eclipse.jface.text.ITextHoverExtension2 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewer.java index 786e9af3ba3..1a7ed56fc5b 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewer.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewer.java @@ -21,85 +21,78 @@ import org.eclipse.jface.viewers.ISelectionProvider; /** - * A text viewer connects a text widget with an - * {@link org.eclipse.jface.text.IDocument}. The document is used as the - * widget's text model. + * A text viewer connects a text widget with an {@link org.eclipse.jface.text.IDocument}. The + * document is used as the widget's text model. * <p> * It supports the following kinds of listeners: + * </p> * <ul> * <li>view port listeners to inform about changes of the viewer's view port</li> - * <li>text listeners to inform about changes of the document and the - * subsequent viewer change</li> - * <li>text input listeners to inform about changes of the viewer's input - * document.</li> + * <li>text listeners to inform about changes of the document and the subsequent viewer change</li> + * <li>text input listeners to inform about changes of the viewer's input document.</li> * </ul> - * A text viewer supports a set of configuration options and plug-ins defining - * its behavior: + * A text viewer supports a set of configuration options and plug-ins defining its behavior: * <ul> * <li>undo manager</li> * <li>double click behavior</li> * <li>auto indentation</li> * <li>text hover</li> * </ul> - * Installed plug-ins are not automatically activated. Plug-ins must be - * activated with the <code>activatePlugins</code> call. Most plug-ins can be - * defined per content type. Content types are derived from a partitioning of - * the text viewer's input document. In case of documents that support multiple - * partitionings, the implementer is responsible for determining the - * partitioning to use. * <p> - * A text viewer also provides the concept of event consumption. Events handled - * by the viewer can be filtered and processed by a dynamic event consumer. With - * {@link org.eclipse.jface.text.ITextViewerExtension}, this mechanism has been - * replaced with the support for - * {@link org.eclipse.swt.custom.VerifyKeyListener}. + * Installed plug-ins are not automatically activated. Plug-ins must be activated with the + * <code>activatePlugins</code> call. Most plug-ins can be defined per content type. Content types + * are derived from a partitioning of the text viewer's input document. In case of documents that + * support multiple partitionings, the implementer is responsible for determining the partitioning + * to use. + * </p> * <p> - * A text viewer provides several text editing functions, some of them are - * configurable, through a text operation target interface. It also supports a - * presentation mode in which it only shows a specified section of its document. - * By calling <code>setVisibleRegion</code> clients define which section is - * visible. Clients can get access to this section by calling - * <code>getVisibleRegion</code>. The viewer's presentation mode does not - * affect any client of the viewer other than text listeners. With - * {@link org.eclipse.jface.text.ITextViewerExtension5} the visible region - * support has been reworked. With that extension interface, text viewers are - * allowed to show fractions of their input document. I.e. a widget selection of - * two visually neighboring characters is no longer guaranteed to be two - * neighboring characters in the viewer's input document. Thus, viewers - * implementing {@link org.eclipse.jface.text.ITextViewerExtension5} are - * potentially forced to change the fractions of the input document that are - * shown when clients ask for the visible region. + * A text viewer also provides the concept of event consumption. Events handled by the viewer can be + * filtered and processed by a dynamic event consumer. With + * {@link org.eclipse.jface.text.ITextViewerExtension}, this mechanism has been replaced with the + * support for {@link org.eclipse.swt.custom.VerifyKeyListener}. + * </p> + * <p> + * A text viewer provides several text editing functions, some of them are configurable, through a + * text operation target interface. It also supports a presentation mode in which it only shows a + * specified section of its document. By calling <code>setVisibleRegion</code> clients define which + * section is visible. Clients can get access to this section by calling + * <code>getVisibleRegion</code>. The viewer's presentation mode does not affect any client of the + * viewer other than text listeners. With {@link org.eclipse.jface.text.ITextViewerExtension5} the + * visible region support has been reworked. With that extension interface, text viewers are allowed + * to show fractions of their input document. I.e. a widget selection of two visually neighboring + * characters is no longer guaranteed to be two neighboring characters in the viewer's input + * document. Thus, viewers implementing {@link org.eclipse.jface.text.ITextViewerExtension5} are + * potentially forced to change the fractions of the input document that are shown when clients ask + * for the visible region. + * </p> * <p> * - * In order to provide backward compatibility for clients of - * <code>ITextViewer</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>ITextViewer</code>, extension + * interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension} since version 2.0 - * replacing the event consumer mechanism and introducing the concept of rewrite - * targets and means to manage the viewer's redraw behavior</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension2}since version 2.1 - * adding a way to invalidate a viewer's presentation and setters for hovers. - * </li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension3} since version 2.1 - * which itself was replaced by - * {@link org.eclipse.jface.text.ITextViewerExtension5} in version 3.0</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension4} since version 3.0 - * introducing focus handling for widget token keepers and the concept of text - * presentation listeners.</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension5} since version 3.0 - * extending the visible region concept with explicit handling and conversion - * of widget and model coordinates.</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension6} since version 3.1 - * extending the text viewer with the ability to detect hyperlinks and access the undo manager.</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension7} since version 3.3 - * extending the text viewer with the ability to install tabs to spaces conversion.</li> - * <li>{@link org.eclipse.jface.text.ITextViewerExtension8} since version 3.4 - * extending the text viewer with the ability to print and rich hover support.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension} since version 2.0 replacing the event + * consumer mechanism and introducing the concept of rewrite targets and means to manage the + * viewer's redraw behavior</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension2}since version 2.1 adding a way to + * invalidate a viewer's presentation and setters for hovers.</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension3} since version 2.1 which itself was + * replaced by {@link org.eclipse.jface.text.ITextViewerExtension5} in version 3.0</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension4} since version 3.0 introducing focus + * handling for widget token keepers and the concept of text presentation listeners.</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension5} since version 3.0 extending the visible + * region concept with explicit handling and conversion of widget and model coordinates.</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension6} since version 3.1 extending the text + * viewer with the ability to detect hyperlinks and access the undo manager.</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension7} since version 3.3 extending the text + * viewer with the ability to install tabs to spaces conversion.</li> + * <li>{@link org.eclipse.jface.text.ITextViewerExtension8} since version 3.4 extending the text + * viewer with the ability to print and rich hover support.</li> + * </ul> * <p> - * Clients may implement this interface and its extension interfaces or use the - * standard implementation {@link org.eclipse.jface.text.TextViewer}.</p> + * Clients may implement this interface and its extension interfaces or use the standard + * implementation {@link org.eclipse.jface.text.TextViewer}. + * </p> * * @see org.eclipse.jface.text.ITextViewerExtension * @see org.eclipse.jface.text.ITextViewerExtension2 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IUndoManager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IUndoManager.java index e72fa45ea68..5a69ce65da1 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IUndoManager.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IUndoManager.java @@ -14,20 +14,20 @@ package org.eclipse.jface.text; /** - * An undo manager is connected to at most one - * {@link org.eclipse.jface.text.ITextViewer}. + * An undo manager is connected to at most one {@link org.eclipse.jface.text.ITextViewer}. * <p> - * It monitors the text viewer and keeps a history of the changes applied to the - * viewer. The undo manager groups those changes into user interactions which on - * an undo request are rolled back in one atomic change.</p> + * It monitors the text viewer and keeps a history of the changes applied to the viewer. The undo + * manager groups those changes into user interactions which on an undo request are rolled back in + * one atomic change. + * </p> * <p> - * In order to provide backward compatibility for clients of - * <code>IUndoManager</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IUndoManager</code>, extension + * interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.IUndoManagerExtension} since version 3.1 - * introducing access to the undo context.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.IUndoManagerExtension} since version 3.1 introducing access to + * the undo context.</li> + * </ul> * <p> * Clients may implement this interface or use the standard implementation * <code>TextViewerUndoManager</code>. diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionListener.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionListener.java index 6ec55c9a1de..f1580a0da40 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionListener.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionListener.java @@ -17,23 +17,24 @@ package org.eclipse.jface.text.contentassist; /** * A completion listener is informed before the content assistant computes completion proposals. * <p> - * In order to provide backward compatibility for clients of <code>ICompletionListener</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>ICompletionListener</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> + * <ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionListenerExtension} since version 3.4 + * introducing the following functions: * <ul> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionListenerExtension} since version 3.4 introducing - * the following functions: - * <ul> - * <li>additional notification about restarting the current code assist session</li> - * </ul> - * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionListenerExtension2} since version 3.8 introducing - * the following functions: - * <ul> - * <li>additional notification after applying a proposal</li> - * </ul> - * </li> + * <li>additional notification about restarting the current code assist session</li> + * </ul> + * </li> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionListenerExtension2} since version 3.8 + * introducing the following functions: + * <ul> + * <li>additional notification after applying a proposal</li> + * </ul> + * </li> * </ul> - * </p> * * <p> * Clients may implement this interface. diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionProposal.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionProposal.java index a1fb9ef3209..0bd2ce5baad 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionProposal.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionProposal.java @@ -20,67 +20,69 @@ import org.eclipse.jface.text.IDocument; /** - * The interface of completion proposals generated by content assist processors. - * A completion proposal contains information used to present the proposed completion - * to the user, to insert the completion should the user select it, and to present - * context information for the chosen completion once it has been inserted. + * The interface of completion proposals generated by content assist processors. A completion + * proposal contains information used to present the proposed completion to the user, to insert the + * completion should the user select it, and to present context information for the chosen + * completion once it has been inserted. * <p> - * In order to provide backward compatibility for clients of <code>ICompletionProposal</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>ICompletionProposal</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> + * <ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension} since version 2.0 + * introducing the following functions: * <ul> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension} since version 2.0 introducing - * the following functions: - * <ul> - * <li>handling of trigger characters other than ENTER</li> - * <li>completion proposal validation for a given offset</li> - * <li>context information can be freely positioned</li> - * </ul> + * <li>handling of trigger characters other than ENTER</li> + * <li>completion proposal validation for a given offset</li> + * <li>context information can be freely positioned</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension2} since version 2.1 introducing - * the following functions: - * <ul> - * <li>handling of trigger characters with modifiers</li> - * <li>visual indication for selection of a proposal</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension2} since version 2.1 + * introducing the following functions: + * <ul> + * <li>handling of trigger characters with modifiers</li> + * <li>visual indication for selection of a proposal</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension3} since version 3.0 introducing - * the following functions: - * <ul> - * <li>provision of a custom information control creator</li> - * <li>provide a custom completion text and offset for prefix completion</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension3} since version 3.0 + * introducing the following functions: + * <ul> + * <li>provision of a custom information control creator</li> + * <li>provide a custom completion text and offset for prefix completion</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension4} since version 3.1 introducing - * the following functions: - * <ul> - * <li>specify whether a proposal is automatically insertable</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension4} since version 3.1 + * introducing the following functions: + * <ul> + * <li>specify whether a proposal is automatically insertable</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension5} since version 3.2 introducing - * the following function: - * <ul> - * <li>Allow background computation of the additional info</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension5} since version 3.2 + * introducing the following function: + * <ul> + * <li>Allow background computation of the additional info</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension6} since version 3.4 introducing - * the following function: - * <ul> - * <li>Allow styled ranges in the display string.</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension6} since version 3.4 + * introducing the following function: + * <ul> + * <li>Allow styled ranges in the display string.</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension7} since version 3.11 introducing - * the following function: - * <ul> - * <li>Emphasize ranges in the styled display string of the proposal that match the token at the - * current caret offset.</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.ICompletionProposalExtension7} since version 3.11 + * introducing the following function: + * <ul> + * <li>Emphasize ranges in the styled display string of the proposal that match the token at the + * current caret offset.</li> + * </ul> * </li> * </ul> - * </p> + * * <p> * This interface can be implemented by clients. By default, clients use - * {@link org.eclipse.jface.text.contentassist.CompletionProposal} as the - * standard implementer of this interface. + * {@link org.eclipse.jface.text.contentassist.CompletionProposal} as the standard implementer of + * this interface. * </p> * * @see IContentAssistProcessor diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java index 20cd25e394a..f6954cda69f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContentAssistant.java @@ -17,59 +17,60 @@ import org.eclipse.jface.text.ITextViewer; /** - * An <code>IContentAssistant</code> provides support on interactive content completion. - * The content assistant is a {@link org.eclipse.jface.text.ITextViewer} add-on. Its - * purpose is to propose, display, and insert completions of the content - * of the text viewer's document at the viewer's cursor position. In addition - * to handle completions, a content assistant can also be requested to provide - * context information. Context information is shown in a tool tip like popup. - * As it is not always possible to determine the exact context at a given - * document offset, a content assistant displays the possible contexts and requests - * the user to choose the one whose information should be displayed. + * An <code>IContentAssistant</code> provides support on interactive content completion. The content + * assistant is a {@link org.eclipse.jface.text.ITextViewer} add-on. Its purpose is to propose, + * display, and insert completions of the content of the text viewer's document at the viewer's + * cursor position. In addition to handle completions, a content assistant can also be requested to + * provide context information. Context information is shown in a tool tip like popup. As it is not + * always possible to determine the exact context at a given document offset, a content assistant + * displays the possible contexts and requests the user to choose the one whose information should + * be displayed. * <p> - * A content assistant has a list of {@link org.eclipse.jface.text.contentassist.IContentAssistProcessor} - * objects each of which is registered for a particular document content - * type. The content assistant uses the processors to react on the request - * of completing documents or presenting context information. + * A content assistant has a list of + * {@link org.eclipse.jface.text.contentassist.IContentAssistProcessor} objects each of which is + * registered for a particular document content type. The content assistant uses the processors to + * react on the request of completing documents or presenting context information. * </p> * <p> - * In order to provide backward compatibility for clients of <code>IContentAssistant</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IContentAssistant</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> + * <ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension} since version 3.0 + * introducing the following functions: * <ul> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension} since version 3.0 introducing - * the following functions: - * <ul> - * <li>handle documents with multiple partitions</li> - * <li>insertion of common completion prefixes</li> - * </ul> + * <li>handle documents with multiple partitions</li> + * <li>insertion of common completion prefixes</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension2} since version 3.2 introducing - * the following functions: - * <ul> - * <li>repeated invocation (cycling) mode</li> - * <li>completion listeners</li> - * <li>a local status line for the completion popup</li> - * <li>control over the behavior when no proposals are available</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension2} since version 3.2 + * introducing the following functions: + * <ul> + * <li>repeated invocation (cycling) mode</li> + * <li>completion listeners</li> + * <li>a local status line for the completion popup</li> + * <li>control over the behavior when no proposals are available</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension3} since version 3.2 introducing - * the following function: - * <ul> - * <li>a key-sequence to listen for in repeated invocation mode</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension3} since version 3.2 + * introducing the following function: + * <ul> + * <li>a key-sequence to listen for in repeated invocation mode</li> + * </ul> * </li> - * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension4} since version 3.4 introducing - * the following function: - * <ul> - * <li>allows to get a handler for the given command identifier</li> - * </ul> + * <li>{@link org.eclipse.jface.text.contentassist.IContentAssistantExtension4} since version 3.4 + * introducing the following function: + * <ul> + * <li>allows to get a handler for the given command identifier</li> + * </ul> * </li> * </ul> - * </p> + * * <p> * The interface can be implemented by clients. By default, clients use - * {@link org.eclipse.jface.text.contentassist.ContentAssistant} as the standard - * implementer of this interface. + * {@link org.eclipse.jface.text.contentassist.ContentAssistant} as the standard implementer of this + * interface. * </p> * * @see org.eclipse.jface.text.ITextViewer diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContextInformation.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContextInformation.java index 68d86f928d6..708b03c3e20 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContextInformation.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/IContextInformation.java @@ -17,23 +17,21 @@ import org.eclipse.swt.graphics.Image; /** - * The interface of context information presented to the user and - * generated by content assist processors. + * The interface of context information presented to the user and generated by content assist + * processors. * <p> - * In order to provide backward compatibility for clients of - * <code>IContextInformation</code>, extension interfaces are used to - * provide a means of evolution. The following extension interfaces + * In order to provide backward compatibility for clients of <code>IContextInformation</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces * exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.contentassist.IContextInformationExtension} - * since version 2.0 introducing the ability to freely position the - * context information.</li> + * <li>{@link org.eclipse.jface.text.contentassist.IContextInformationExtension} since version 2.0 + * introducing the ability to freely position the context information.</li> * </ul> - * </p> * <p> * The interface can be implemented by clients. By default, clients use - * {@link org.eclipse.jface.text.contentassist.ContextInformation} as - * the standard implementer of this interface. + * {@link org.eclipse.jface.text.contentassist.ContextInformation} as the standard implementer of + * this interface. * </p> * * @see IContentAssistProcessor diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html index ffecf1a2500..88e13850944 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html @@ -84,6 +84,5 @@ in the document.</li> IFormattingContext)</tt> with the created formatting context and the document to be formatted.</li> </ul> -<p></p> </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkDetector.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkDetector.java index 47246558de8..107f4575cf1 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkDetector.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkDetector.java @@ -19,20 +19,18 @@ import org.eclipse.jface.text.source.SourceViewerConfiguration; /** - * A hyperlink detector tries to find a hyperlink at - * a given location in a given text viewer. + * A hyperlink detector tries to find a hyperlink at a given location in a given text viewer. * <p> - * In order to provide backward compatibility for clients of <code>IHyperlinkDetector</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IHyperlinkDetector</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> * <ul> - * <li>{@link IHyperlinkDetectorExtension} since version 3.3, - * adds the ability to dispose a hyperlink detector - * </li> - * <li>{@link IHyperlinkDetectorExtension2} since version 3.3, - * adds the ability to specify the state mask of the modifier - * keys that need to be pressed for this hyperlink detector - * </li> - * </ul></p> + * <li>{@link IHyperlinkDetectorExtension} since version 3.3, adds the ability to dispose a + * hyperlink detector</li> + * <li>{@link IHyperlinkDetectorExtension2} since version 3.3, adds the ability to specify the state + * mask of the modifier keys that need to be pressed for this hyperlink detector</li> + * </ul> * <p> * Clients may implement this interface. * </p> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkPresenter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkPresenter.java index d0d60392e7a..f926faccd92 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkPresenter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/IHyperlinkPresenter.java @@ -17,24 +17,22 @@ import org.eclipse.jface.text.ITextViewer; /** - * A hyperlink presenter shows hyperlinks on the installed text viewer - * and allows to pick one on of the hyperlinks. + * A hyperlink presenter shows hyperlinks on the installed text viewer and allows to pick one on of + * the hyperlinks. * <p> - * In order to provide backward compatibility for clients of <code>IHyperlinkDetector</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IHyperlinkDetector</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> * <ul> - * <li>{@link IHyperlinkPresenterExtension} since version 3.4, - * adds the ability to query whether the currently shown hyperlinks - * can be hidden. - * </li> - * <li>{@link IHyperlinkPresenterExtension2} since version 3.7, - * adds the ability distinguish between the modes in which the - * control either takes focus or not when visible. - * </li> - * </ul></p> + * <li>{@link IHyperlinkPresenterExtension} since version 3.4, adds the ability to query whether the + * currently shown hyperlinks can be hidden.</li> + * <li>{@link IHyperlinkPresenterExtension2} since version 3.7, adds the ability distinguish between + * the modes in which the control either takes focus or not when visible.</li> + * </ul> * <p> - * Clients may implement this interface. A default implementation is provided - * through {@link org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter}. + * Clients may implement this interface. A default implementation is provided through + * {@link org.eclipse.jface.text.hyperlink.DefaultHyperlinkPresenter}. * </p> * * @see IHyperlinkPresenterExtension diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationPresenter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationPresenter.java index 6bbcf72ab00..2874e9ae14b 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationPresenter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationPresenter.java @@ -17,25 +17,28 @@ import org.eclipse.jface.text.ITextViewer; /** - * An information presenter shows information available at the text viewer's - * current document position. An <code>IInformationPresenter</code> is a - * {@link org.eclipse.jface.text.ITextViewer} add-on. + * An information presenter shows information available at the text viewer's current document + * position. An <code>IInformationPresenter</code> is a {@link org.eclipse.jface.text.ITextViewer} + * add-on. * <p> - * An information presenters has a list of {@link org.eclipse.jface.text.information.IInformationProvider} objects - * each of which is registered for a particular document content type. - * The presenter uses the strategy objects to retrieve the information to present. + * An information presenters has a list of + * {@link org.eclipse.jface.text.information.IInformationProvider} objects each of which is + * registered for a particular document content type. The presenter uses the strategy objects to + * retrieve the information to present. * </p> * <p> - * In order to provide backward compatibility for clients of <code>IInformationPresenter</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IInformationPresenter</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> * <ul> - * <li>{@link IInformationPresenterExtension} since version 3.0 introducing - * the ability to handle documents with multiple partitions</li> + * <li>{@link IInformationPresenterExtension} since version 3.0 introducing the ability to handle + * documents with multiple partitions</li> * </ul> - * </p> * <p> * The interface can be implemented by clients. By default, clients use - * {@link org.eclipse.jface.text.information.InformationPresenter} as the standard implementer of this interface. + * {@link org.eclipse.jface.text.information.InformationPresenter} as the standard implementer of + * this interface. * </p> * * @see org.eclipse.jface.text.information.IInformationPresenterExtension diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationProvider.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationProvider.java index abb6ce0bea2..7a0b3a62593 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationProvider.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/IInformationProvider.java @@ -20,15 +20,16 @@ import org.eclipse.jface.text.ITextViewer; /** * Provides information related to the content of a text viewer. * <p> - * In order to provide backward compatibility for clients of <code>IInformationProvider</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IInformationProvider</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> * <ul> - * <li>{@link IInformationProviderExtension} since version 2.1 introducing - * the ability to provide the element for a given subject</li> - * <li>{@link IInformationProviderExtension2} since version 3.0 introducing - * the ability to provide its own information control creator</li> + * <li>{@link IInformationProviderExtension} since version 2.1 introducing the ability to provide + * the element for a given subject</li> + * <li>{@link IInformationProviderExtension2} since version 3.0 introducing the ability to provide + * its own information control creator</li> * </ul> - * </p> * <p> * Clients may implement this interface. * </p> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationReconciler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationReconciler.java index 2a446322b3f..222233ed5b9 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationReconciler.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationReconciler.java @@ -18,43 +18,36 @@ import org.eclipse.jface.text.ITextViewer; /** - * An <code>IPresentationReconciler</code> defines and maintains the - * representation of a text viewer's document in the presence of changes applied - * to the document. An <code>IPresentationReconciler</code> is a - * <code>ITextViewer</code> add-on. + * An <code>IPresentationReconciler</code> defines and maintains the representation of a text + * viewer's document in the presence of changes applied to the document. An + * <code>IPresentationReconciler</code> is a <code>ITextViewer</code> add-on. * <p> - * The presentation reconciler keeps track of changes applied to the text - * viewer. It sends each change to presentation damagers which are registered - * for the content types of the regions in which the change occurred. The - * presentation reconciler passes the computed damage to presentation repairer - * which construct text presentations. When applied to the presentation - * reconciler's text viewer, those text presentations bring the document's - * presentation in sync with the document's content and thus repair the damage. - * A presentation damager is expected to return damage which is a valid input - * for a presentation repairer registered for the same content type as the - * damager. + * The presentation reconciler keeps track of changes applied to the text viewer. It sends each + * change to presentation damagers which are registered for the content types of the regions in + * which the change occurred. The presentation reconciler passes the computed damage to presentation + * repairer which construct text presentations. When applied to the presentation reconciler's text + * viewer, those text presentations bring the document's presentation in sync with the document's + * content and thus repair the damage. A presentation damager is expected to return damage which is + * a valid input for a presentation repairer registered for the same content type as the damager. * </p> * <p> - * A presentation reconciler should always be configured with a pair of - * damager/repairer strategies. I.e. for each damager there should be a - * corresponding repairer. + * A presentation reconciler should always be configured with a pair of damager/repairer strategies. + * I.e. for each damager there should be a corresponding repairer. * </p> * <p> - * The interface may be implemented by clients. Clients may use - * <code>PresentationReconciler</code> as the standard implementation of this - * interface. + * The interface may be implemented by clients. Clients may use <code>PresentationReconciler</code> + * as the standard implementation of this interface. * </p> * <p> - * In order to provided backward compatibility for clients of - * <code>IPresentationReconciler</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>IPresentationReconciler</code>, + * extension interfaces are used to provide a means of evolution. The following extension interface + * exists: + * </p> * <ul> - * <li> - * {@link org.eclipse.jface.text.presentation.IPresentationReconcilerExtension} - * since version 3.0 adding support for documents with multiple partitionings. - * </li> + * <li>{@link org.eclipse.jface.text.presentation.IPresentationReconcilerExtension} since version + * 3.0 adding support for documents with multiple partitionings.</li> * </ul> - * </p> + * * * @see org.eclipse.jface.text.presentation.IPresentationReconcilerExtension * @see org.eclipse.jface.text.ITextViewer diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/IQuickAssistAssistant.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/IQuickAssistAssistant.java index a99d01ce82e..4f667f737b5 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/IQuickAssistAssistant.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/IQuickAssistAssistant.java @@ -25,31 +25,30 @@ import org.eclipse.jface.text.source.ISourceViewerExtension3; /** - * An <code>IQuickAssistAssistant</code> provides support for quick fixes and quick - * assists. - * The quick assist assistant is a {@link ISourceViewer} add-on. Its - * purpose is to propose, display, and insert quick assists and quick fixes - * available at the current source viewer's quick assist invocation context. + * An <code>IQuickAssistAssistant</code> provides support for quick fixes and quick assists. The + * quick assist assistant is a {@link ISourceViewer} add-on. Its purpose is to propose, display, and + * insert quick assists and quick fixes available at the current source viewer's quick assist + * invocation context. * <p> - * The quick assist assistant can be configured with a {@link IQuickAssistProcessor} - * which provides the possible quick assist and quick fix completions. + * The quick assist assistant can be configured with a {@link IQuickAssistProcessor} which provides + * the possible quick assist and quick fix completions. + * </p> + * <p> + * In order to provide backward compatibility for clients of <code>IQuickAssistAssistant</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: * </p> - * In order to provide backward compatibility for clients of - * <code>IQuickAssistAssistant</code>, extension interfaces are used to - * provide a means of evolution. The following extension interfaces exist: * <ul> - * <li>{@link IQuickAssistAssistantExtension} since version 3.4 introducing the - * following function: + * <li>{@link IQuickAssistAssistantExtension} since version 3.4 introducing the following function: * <ul> - * <li>allows to get a handler for the given command identifier</li> - * <li>allows to enable support for colored labels in the proposal popup</li> + * <li>allows to get a handler for the given command identifier</li> + * <li>allows to enable support for colored labels in the proposal popup</li> * </ul> * </li> - * </p> + * </ul> * <p> - * The interface can be implemented by clients. By default, clients use - * {@link QuickAssistAssistant} as the standard - * implementer of this interface. + * The interface can be implemented by clients. By default, clients use {@link QuickAssistAssistant} + * as the standard implementer of this interface. * </p> * * @see ISourceViewer diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcileStep.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcileStep.java index 7f9950dcd50..14fb8ec53cb 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcileStep.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcileStep.java @@ -20,39 +20,40 @@ import org.eclipse.jface.text.IRegion; /** * A reconcile step is one of several steps of a - * {@linkplain org.eclipse.jface.text.reconciler.IReconcilingStrategy reconcile strategy} - * that consists of several steps. This relationship is not coded into an interface but - * should be used by clients who's reconcile strategy consists of several steps. + * {@linkplain org.eclipse.jface.text.reconciler.IReconcilingStrategy reconcile strategy} that + * consists of several steps. This relationship is not coded into an interface but should be used by + * clients who's reconcile strategy consists of several steps. * <p> - * If a reconcile step has an {@linkplain org.eclipse.jface.text.reconciler.IReconcilableModel input model} - * it will compute the correct model for the next step in the chain and set the next steps - * input model before <code>reconcile</code> gets called on that next step. After the last - * step has reconciled the {@linkplain org.eclipse.jface.text.reconciler.IReconcileResult reconcile result} - * array gets returned to the previous step. Each step in the chain adapts the result to its - * input model and returns it to its previous step. + * If a reconcile step has an {@linkplain org.eclipse.jface.text.reconciler.IReconcilableModel input + * model} it will compute the correct model for the next step in the chain and set the next steps + * input model before <code>reconcile</code> gets called on that next step. After the last step has + * reconciled the {@linkplain org.eclipse.jface.text.reconciler.IReconcileResult reconcile result} + * array gets returned to the previous step. Each step in the chain adapts the result to its input + * model and returns it to its previous step. * </p> * <p> - * Example: Assume a strategy consists of steps A, B and C. And the main model is M. - * The strategy will set M to be A's input model. What will happen is: + * Example: Assume a strategy consists of steps A, B and C. And the main model is M. The strategy + * will set M to be A's input model. What will happen is: + * </p> * <ol> - * <li>A.setInputModel(M)</li> - * <li>A.reconcile: A reconciles M</li> - * <li>A computes the model for B => MB</li> - * <li>B.setInputModel(MB)</li> - * <li>B.reconcile: B reconciles MB</li> - * <li>B computes the model for C => MC</li> - * <li>C.setInputModel(MC)</li> - * <li>C.reconcile: C reconciles MC</li> - * <li>C returns result RC to step B</li> - * <li>B adapts the RC to MB and merges with its own results</li> - * <li>B returns result RB to step A</li> - * <li>A adapts the result to M and merges with its own results</li> - * <li>A returns the result to the reconcile strategy</li> + * <li>A.setInputModel(M)</li> + * <li>A.reconcile: A reconciles M</li> + * <li>A computes the model for B => MB</li> + * <li>B.setInputModel(MB)</li> + * <li>B.reconcile: B reconciles MB</li> + * <li>B computes the model for C => MC</li> + * <li>C.setInputModel(MC)</li> + * <li>C.reconcile: C reconciles MC</li> + * <li>C returns result RC to step B</li> + * <li>B adapts the RC to MB and merges with its own results</li> + * <li>B returns result RB to step A</li> + * <li>A adapts the result to M and merges with its own results</li> + * <li>A returns the result to the reconcile strategy</li> * </ol> - * </p> * <p> * This interface must be implemented by clients. * </p> + * * @since 3.0 */ public interface IReconcileStep { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconciler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconciler.java index 7637c7ac5e9..fc3fa2c32c2 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconciler.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconciler.java @@ -17,33 +17,31 @@ import org.eclipse.jface.text.ITextViewer; /** - * An <code>IReconciler</code> defines and maintains a model of the content - * of the text viewer's document in the presence of changes applied to this - * document. An <code>IReconciler</code> is a {@link org.eclipse.jface.text.ITextViewer} add-on. + * An <code>IReconciler</code> defines and maintains a model of the content of the text viewer's + * document in the presence of changes applied to this document. An <code>IReconciler</code> is a + * {@link org.eclipse.jface.text.ITextViewer} add-on. * <p> - * Reconcilers are assumed to be asynchronous, i.e. they allow a certain - * temporal window of inconsistency between the document and the model of - * the content of this document. + * Reconcilers are assumed to be asynchronous, i.e. they allow a certain temporal window of + * inconsistency between the document and the model of the content of this document. * </p> * <p> - * Reconcilers have a list of {@link org.eclipse.jface.text.reconciler.IReconcilingStrategy} - * objects each of which is registered for a particular document content type. - * The reconciler uses the strategy objects to react on the changes applied - * to the text viewer's document. - *</p> + * Reconcilers have a list of {@link org.eclipse.jface.text.reconciler.IReconcilingStrategy} objects + * each of which is registered for a particular document content type. The reconciler uses the + * strategy objects to react on the changes applied to the text viewer's document. + * </p> * <p> * In order to provide backward compatibility for clients of <code>IReconciler</code>, extension * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * </p> * <ul> * <li>{@link org.eclipse.jface.text.reconciler.IReconcilerExtension} since version 3.0 introducing - * the ability to be aware of documents with multiple partitionings.</li> + * the ability to be aware of documents with multiple partitionings.</li> * </ul> - * </p> * <p> * The interface can be implemented by clients. By default, clients use * {@link org.eclipse.jface.text.reconciler.MonoReconciler} or - * {@link org.eclipse.jface.text.reconciler.Reconciler} as the standard - * implementers of this interface. + * {@link org.eclipse.jface.text.reconciler.Reconciler} as the standard implementers of this + * interface. * </p> * * @see ITextViewer diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcilingStrategy.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcilingStrategy.java index 027e494ff5e..c70411c4d70 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcilingStrategy.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/IReconcilingStrategy.java @@ -18,33 +18,32 @@ import org.eclipse.jface.text.IRegion; /** - * A reconciling strategy is used by an reconciler to reconcile a model - * based on text of a particular content type. It provides methods for - * incremental as well as non-incremental reconciling. + * A reconciling strategy is used by an reconciler to reconcile a model based on text of a + * particular content type. It provides methods for incremental as well as non-incremental + * reconciling. * <p> - * If a reconcile strategy consists of several steps between which - * model transformation is desired the each step should implement - * {@link org.eclipse.jface.text.reconciler.IReconcileStep}. + * If a reconcile strategy consists of several steps between which model transformation is desired + * the each step should implement {@link org.eclipse.jface.text.reconciler.IReconcileStep}. * </p> * <p> - * In order to provide backward compatibility for clients of <code>IReconcilingStrategy</code>, extension - * interfaces are used to provide a means of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IReconcilingStrategy</code>, + * extension interfaces are used to provide a means of evolution. The following extension interfaces + * exist: + * </p> + * <ul> + * <li>{@link org.eclipse.jface.text.reconciler.IReconcilingStrategyExtension} since version 2.0 + * introducing the following functions: * <ul> - * <li>{@link org.eclipse.jface.text.reconciler.IReconcilingStrategyExtension} since version 2.0 introducing - * the following functions: - * <ul> - * <li>usage of a progress monitor</li> - * <li>initial reconciling step: if a reconciler runs as periodic activity in the background, this - * methods offers the reconciler a chance for initializing its strategies and achieving a - * reconciled state before the periodic activity starts.</li> - * </ul> + * <li>usage of a progress monitor</li> + * <li>initial reconciling step: if a reconciler runs as periodic activity in the background, this + * methods offers the reconciler a chance for initializing its strategies and achieving a reconciled + * state before the periodic activity starts.</li> + * </ul> * </li> * </ul> - * </p> * <p> - * This interface must be implemented by clients. Implementers should be - * registered with a reconciler in order get involved in the reconciling - * process. + * This interface must be implemented by clients. Implementers should be registered with a + * reconciler in order get involved in the reconciling process. * </p> */ public interface IReconcilingStrategy { diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java index fa047123574..f1387ec5dd0 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java @@ -14,22 +14,23 @@ package org.eclipse.jface.text.source; /** - * An annotation access provides access to information that is not available via - * the API of {@link org.eclipse.jface.text.source.Annotation}. With version - * 3.0 all this information is now available from the annotation itself. + * An annotation access provides access to information that is not available via the API of + * {@link org.eclipse.jface.text.source.Annotation}. With version 3.0 all this information is now + * available from the annotation itself. * <p> * - * In order to provide backward compatibility for clients of - * <code>IAnnotationAccess</code>, extension interfaces are used as a means - * of evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IAnnotationAccess</code>, + * extension interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.source.IAnnotationAccessExtension} since - * version 3.0 replacing all methods in that interface</li> - * <li>{@link IAnnotationAccessExtension2} since - * version 3.2 allowing to set a quick assist assistant to an annotation access.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.source.IAnnotationAccessExtension} since version 3.0 replacing + * all methods in that interface</li> + * <li>{@link IAnnotationAccessExtension2} since version 3.2 allowing to set a quick assist + * assistant to an annotation access.</li> + * </ul> * <p> - * Clients usually implement this interface and its extension interfaces.</p> + * Clients usually implement this interface and its extension interfaces. + * </p> * * @see org.eclipse.jface.text.source.IAnnotationAccessExtension * @see org.eclipse.jface.text.source.Annotation diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccessExtension.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccessExtension.java index adc49999b34..6aed406d588 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccessExtension.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccessExtension.java @@ -18,15 +18,19 @@ import org.eclipse.swt.graphics.Rectangle; import org.eclipse.swt.widgets.Canvas; /** - * Extension interface for {@link org.eclipse.jface.text.source.IAnnotationAccess}.<p> - * This interface replaces the methods of <code>IAnnotationAccess</code>.<p> + * Extension interface for {@link org.eclipse.jface.text.source.IAnnotationAccess}. + * <p> + * This interface replaces the methods of <code>IAnnotationAccess</code>. + * </p> + * <p> * This interface provides + * </p> * <ul> - * <li> a label for the annotation type of a given annotation</li> - * <li> the paint layer of a given annotation</li> - * <li> means to paint a given annotation</li> - * <li> information about the type hierarchy of the annotation type of a given annotation</li> - * <ul>. + * <li>a label for the annotation type of a given annotation</li> + * <li>the paint layer of a given annotation</li> + * <li>means to paint a given annotation</li> + * <li>information about the type hierarchy of the annotation type of a given annotation</li> + * </ul> * * @see org.eclipse.jface.text.source.IAnnotationAccess * @since 3.0 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java index 131377c68df..dfd64da6605 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java @@ -16,23 +16,22 @@ package org.eclipse.jface.text.source; /** - * Provides the information to be displayed in a hover popup window which - * appears over the presentation area of annotations. + * Provides the information to be displayed in a hover popup window which appears over the + * presentation area of annotations. * <p> - * In order to provide backward compatibility for clients of - * <code>IAnnotationHover</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IAnnotationHover</code>, + * extension interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension} since - * version 3.0 allowing a text hover to provide a creator for the hover control. - * This allows for sophisticated hovers in a way that information computed by - * the hover can be displayed in the best possible form.</li> - * <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension2} since - * version 3.2 allowing a text hover to specify whether it handles mouse-wheel - * events itself.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension} since version 3.0 allowing a + * text hover to provide a creator for the hover control. This allows for sophisticated hovers in a + * way that information computed by the hover can be displayed in the best possible form.</li> + * <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension2} since version 3.2 allowing a + * text hover to specify whether it handles mouse-wheel events itself.</li> + * </ul> * <p> - * Clients may implement this interface.</p> + * Clients may implement this interface. + * </p> * * @see org.eclipse.jface.text.source.IAnnotationHoverExtension * @see org.eclipse.jface.text.source.IAnnotationHoverExtension2 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcher.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcher.java index 8badeceadb9..3fbadf83860 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcher.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ICharacterPairMatcher.java @@ -29,12 +29,12 @@ import org.eclipse.jface.text.IRegion; * In order to provide backward compatibility for clients of <code>ICharacterPairMatcher</code>, * extension interfaces are used to provide a means of evolution. The following extension interface * exists: + * </p> * <ul> * <li>{@link org.eclipse.jface.text.source.ICharacterPairMatcherExtension} since version 3.8 * introducing the concept of matching peer character and enclosing peer characters for a given * selection.</li> * </ul> - * </p> * <p> * Clients may implement this interface and its extension interface or use the default * implementation provided by <code>DefaultCharacterPairMatcher</code>. diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffer.java index eac1c0fa0b5..abaf5d95222 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffer.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ILineDiffer.java @@ -18,26 +18,25 @@ import org.eclipse.jface.text.BadLocationException; /** * Protocol that allows direct access to line information. Usually, implementations will also - * implement <code>IAnnotationModel</code>, which only allows <code>Iterator</code> based access - * to annotations. + * implement <code>IAnnotationModel</code>, which only allows <code>Iterator</code> based access to + * annotations. * <p> - * <code>ILineDiffer</code> also allows to revert any lines to their original - * contents as defined by the quick diff reference used by the receiver. + * <code>ILineDiffer</code> also allows to revert any lines to their original contents as defined by + * the quick diff reference used by the receiver. * </p> * <p> * This interface may be implemented by clients. * </p> * <p> * In order to provide backward compatibility for clients of <code>ILineDiffer</code>, extension - * interfaces are used to provide a means of evolution. The following extension interface - * exists: + * interfaces are used to provide a means of evolution. The following extension interface exists: + * </p> * <ul> - * <li> {@link ILineDifferExtension} (since version 3.1): introducing the concept - * suspending and resuming an <code>ILineDiffer</code>.</li> - * <li> {@link ILineDifferExtension2} (since version 3.3): allowing to query the suspension state - * of an <code>ILineDiffer</code>.</li> + * <li>{@link ILineDifferExtension} (since version 3.1): introducing the concept suspending and + * resuming an <code>ILineDiffer</code>.</li> + * <li>{@link ILineDifferExtension2} (since version 3.3): allowing to query the suspension state of + * an <code>ILineDiffer</code>.</li> * </ul> - * </p> * * @since 3.0 */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java index ff22cb4a181..53c11e7f07c 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java @@ -23,6 +23,7 @@ import org.eclipse.swt.widgets.Control; * overview ruler. * <p> * This interfaces embodies three contracts: + * </p> * <ul> * <li>The overview ruler retrieves the annotations it presents from an annotation model. * <li>The ruler is a visual component which must be integrated in a hierarchy of SWT controls. @@ -30,15 +31,14 @@ import org.eclipse.swt.widgets.Control; * the mapping between coordinates of the ruler's control and line numbers based on the connected * text viewer's document (<code>IVerticalRulerInfo</code>). * </ul> - * </p> * <p> * In order to provide backward compatibility for clients of <code>IOverviewRuler</code>, extension * interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.source.IOverviewRulerExtension} since version 3.8 - * allowing the ruler to set whether to use saturated colors.</li> + * <li>{@link org.eclipse.jface.text.source.IOverviewRulerExtension} since version 3.8 allowing the + * ruler to set whether to use saturated colors.</li> * </ul> - * </p> * <p> * Clients may implement this interface or use the default implementation provided by * <code>OverviewRuler</code>. diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java index 496c0f90cbb..d3d9eb71efa 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java @@ -28,35 +28,34 @@ import org.eclipse.jface.text.ITextViewer; * <li>management of text viewer add-ons * <li>explicit configuration * </ul> - * It is assumed that range indication and visual annotations are shown inside - * the same presentation area. There are no assumptions about whether this area - * is different from the viewer's text widget. + * It is assumed that range indication and visual annotations are shown inside the same presentation + * area. There are no assumptions about whether this area is different from the viewer's text + * widget. * <p> - * As the visibility of visual annotations can dynamically be changed, it is - * assumed that the annotation presentation area can dynamically be hidden if it - * is different from the text widget. + * As the visibility of visual annotations can dynamically be changed, it is assumed that the + * annotation presentation area can dynamically be hidden if it is different from the text widget. * <p> - * In order to provide backward compatibility for clients of - * <code>ISourceViewer</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>ISourceViewer</code>, extension + * interfaces are used as a means of evolution. The following extension interfaces exist: + * </p> * <ul> - * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension} since version 2.1 - * introducing the concept of an annotation overview.</li> - * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension2} since version 3.0 - * allowing source viewers to roll back a previously performed configuration and - * allows access to the viewer's visual annotation model.</li> - * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension3} since version 3.2 - * introducing the concept of a quick assist assistant and providing access - * to the quick assist invocation context as well as the current annotation hover.</li> - * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension4} since version 3.4 - * introducing API to access a minimal set of content assistant APIs.</li> - * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension5} since version 3.13 - * introducing API to access minimal set of code mining APIs.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension} since version 2.1 introducing + * the concept of an annotation overview.</li> + * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension2} since version 3.0 allowing + * source viewers to roll back a previously performed configuration and allows access to the + * viewer's visual annotation model.</li> + * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension3} since version 3.2 introducing + * the concept of a quick assist assistant and providing access to the quick assist invocation + * context as well as the current annotation hover.</li> + * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension4} since version 3.4 introducing + * API to access a minimal set of content assistant APIs.</li> + * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension5} since version 3.13 introducing + * API to access minimal set of code mining APIs.</li> + * </ul> * <p> - * Clients may implement this interface and its extension interfaces or use the - * default implementation provided by - * {@link org.eclipse.jface.text.source.SourceViewer}.</p> + * Clients may implement this interface and its extension interfaces or use the default + * implementation provided by {@link org.eclipse.jface.text.source.SourceViewer}. + * </p> * * @see org.eclipse.jface.text.source.ISourceViewerExtension * @see org.eclipse.jface.text.source.ISourceViewerExtension2 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension4.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension4.java index 0ec61a5166b..9deb91995fe 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension4.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension4.java @@ -19,7 +19,7 @@ import org.eclipse.jface.text.contentassist.IContentAssistant; /** * Extension interface for {@link org.eclipse.jface.text.source.ISourceViewer}. * <p> - * It introduces API to access a minimal set of content assistant APIs.</li> + * It introduces API to access a minimal set of content assistant APIs. * </p> * * @see IContentAssistant diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension5.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension5.java index 0ac525cbf46..f7af2eaae1f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension5.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewerExtension5.java @@ -19,7 +19,7 @@ import org.eclipse.jface.text.codemining.ICodeMiningProvider; /** * Extension interface for {@link org.eclipse.jface.text.source.ISourceViewer}. * <p> - * It introduces API to access a minimal set of code mining APIs.</li> + * It introduces API to access a minimal set of code mining APIs. * </p> * * @see ICodeMining diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java index 2112b4d44bf..2d022a9ee77 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java @@ -21,37 +21,33 @@ import org.eclipse.jface.text.ITextViewer; /** - * This interface defines a visual component which may serve text viewers as an - * annotation presentation area. Implementers of this interface have to define - * the presentation modus. This can either depend on the connected viewer's view - * port or not. If the modus is view port dependent the ruler only shows those - * annotations that are attached to document regions that are visible in the - * view port. If independent, the presented annotations can also be attached to - * invisible document regions. + * This interface defines a visual component which may serve text viewers as an annotation + * presentation area. Implementers of this interface have to define the presentation modus. This can + * either depend on the connected viewer's view port or not. If the modus is view port dependent the + * ruler only shows those annotations that are attached to document regions that are visible in the + * view port. If independent, the presented annotations can also be attached to invisible document + * regions. * * This interfaces comprises three contracts: * <ul> - * <li>The vertical ruler retrieves the annotations it presents from an - * annotation model. - * <li>The ruler is a visual component which must be integrated in a hierarchy - * of SWT controls. - * <li>The ruler provides interested clients with mapping and interaction - * information. This covers the mapping between coordinates of the ruler's - * control and line numbers based on the connected text viewer's document (see - * {@link org.eclipse.jface.text.source.IVerticalRulerInfo}). + * <li>The vertical ruler retrieves the annotations it presents from an annotation model. + * <li>The ruler is a visual component which must be integrated in a hierarchy of SWT controls. + * <li>The ruler provides interested clients with mapping and interaction information. This covers + * the mapping between coordinates of the ruler's control and line numbers based on the connected + * text viewer's document (see {@link org.eclipse.jface.text.source.IVerticalRulerInfo}). * </ul> * <p> - * In order to provide backward compatibility for clients of - * <code>IVerticalRuler</code>, extension interfaces are used as a means of - * evolution. The following extension interfaces exist: + * In order to provide backward compatibility for clients of <code>IVerticalRuler</code>, extension + * interfaces are used as a means of evolution. The following extension interfaces exist: * <ul> - * <li>{@link org.eclipse.jface.text.source.IVerticalRulerExtension} since - * version 2.0 introducing setters for font and mouse button activity location.</li> - * </ul></p> + * <li>{@link org.eclipse.jface.text.source.IVerticalRulerExtension} since version 2.0 introducing + * setters for font and mouse button activity location.</li> + * </ul> * <p> - * Clients may implement this interface or use the default implementation - * provided by {@link org.eclipse.jface.text.source.CompositeRuler} and - * {@link org.eclipse.jface.text.source.VerticalRuler}.</p> + * Clients may implement this interface or use the default implementation provided by + * {@link org.eclipse.jface.text.source.CompositeRuler} and + * {@link org.eclipse.jface.text.source.VerticalRuler}. + * </p> * * @see org.eclipse.jface.text.source.IVerticalRulerExtension * @see org.eclipse.jface.text.ITextViewer 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 0abfab26be6..b0c1b55593a 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,9 +12,9 @@ Provides persistence support for templates. <h3>Packages</h3> <ul> - <li><tt><big><strong>org.eclipse.jface.text.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.workbench.texteditor.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.editors.templates</strong></big></tt></li> + <li><code>org.eclipse.jface.text.templates<</code></li> + <li><code>org.eclipse.ui.workbench.texteditor.templates</code></li> + <li><code>org.eclipse.ui.editors.templates</code></li> </ul> <h3>Introduction</h3> Templates are shortcuts for frequently used fragments of text such as @@ -67,8 +67,6 @@ extension point.</li> <li><tt>TemplatePreferencePage</tt> allows the user to access the templates within a <tt>TemplateStore.</tt></li> </ul> -<ul> -</ul> <h4>Example</h4> See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br> </body> diff --git a/org.eclipse.search/search/org/eclipse/search/ui/package.html b/org.eclipse.search/search/org/eclipse/search/ui/package.html index 8205c76b4f1..3aadf457283 100644 --- a/org.eclipse.search/search/org/eclipse/search/ui/package.html +++ b/org.eclipse.search/search/org/eclipse/search/ui/package.html @@ -27,7 +27,6 @@ dialog properties. Search result view, since 3.0</h3> <p>The search view that shows the search results has been redesigned for 3.0. It is recommended to use and to switch to the new API: -<p> <p>On 'OK', an implementation of a search dialog page creates a <i>search query</i>, represented by an instances of type <tt>ISearchQuery</tt>. The query can be run using API on <tt>NewSearchUI</tt> and will create a <code>ISearchResult</code> as result. <tt>ISearchResultListener</tt> can be added to search results and report changes as <tt>SearchResultEvent</tt>. @@ -40,7 +39,6 @@ visualize the matches contained in the result set. Search result view, before 3.0</h3> <p>For compatibility to searches written prior to 3.0, the following APIs still exist and are functional. The old search result view is called 'classic search view' in the UI. -<p> <p>Before 3.0, the search result view was fully implemented by the search plugin. All search results had to be marked with <i>search markers</i> (<tt>org.eclipse.core.resources.IMarker</tt>, registered under 'org.eclipse.search.searchmarker') <p>The search dialog page (type <tt>ISearchResultView</tt>) could access the single search result view using <tt>SearchUI.getSearchResultView()</tt>. It showed all matches as elements of type <tt>ISearchResultViewEntry</tt>. diff --git a/org.eclipse.text/src/org/eclipse/jface/text/DocumentRewriteSessionType.java b/org.eclipse.text/src/org/eclipse/jface/text/DocumentRewriteSessionType.java index 4daffa770bf..92383400dd2 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/DocumentRewriteSessionType.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/DocumentRewriteSessionType.java @@ -18,13 +18,13 @@ package org.eclipse.jface.text; * A document rewrite session type. * <p> * Allowed values are: + * </p> * <ul> * <li>{@link DocumentRewriteSessionType#UNRESTRICTED}</li> * <li>{@link DocumentRewriteSessionType#UNRESTRICTED_SMALL} (since 3.3)</li> * <li>{@link DocumentRewriteSessionType#SEQUENTIAL}</li> * <li>{@link DocumentRewriteSessionType#STRICTLY_SEQUENTIAL}</li> * </ul> - * </p> * * @see org.eclipse.jface.text.IDocument * @see org.eclipse.jface.text.IDocumentExtension4 diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocument.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocument.java index d161a749231..fba0c365acd 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/IDocument.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocument.java @@ -65,19 +65,19 @@ package org.eclipse.jface.text; * <p> * <code>IDocument</code> throws <code>BadLocationException</code> if the parameters of * queries or manipulation requests are not inside the bounds of the document. The purpose - * of this style of exception handling is + * of this style of exception handling is</p> * <ul> * <li> prepare document for multi-thread access * <li> allow clients to implement backtracking recovery methods * <li> prevent clients from up-front contract checking when dealing with documents. - * </ul></p> + * </ul> * <p> * A document support for searching has deprecated since version 3.0. The recommended way * for searching is to use a {@link org.eclipse.jface.text.FindReplaceDocumentAdapter}.</p> * <p> * In order to provide backward compatibility for clients of <code>IDocument</code>, extension * interfaces are used to provide a means of evolution. The following extension interfaces - * exist: + * exist:</p> * <ul> * <li> {@link org.eclipse.jface.text.IDocumentExtension} since version 2.0 introducing the concept * of post notification replaces in order to allow document listeners to manipulate the document @@ -91,7 +91,7 @@ package org.eclipse.jface.text; * concept of rewrite sessions. A rewrite session is a sequence of document replace operations * that form a semantic unit. It also introduces a modification stamp and the ability to * set the initial line delimiter and to query the default line delimiter.</li> - * </ul></p> + * </ul> * <p> * Clients may implement this interface and its extension interfaces or use the default * implementation provided by <code>AbstractDocument</code> and <code>Document</code>.</p> diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java index fefed90957b..792a795d26c 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java @@ -25,6 +25,7 @@ package org.eclipse.jface.text; * In order to provided backward compatibility for clients of <code>IDocumentPartitioningListener</code>, extension * interfaces are used to provide a means of evolution. The following extension interfaces * exist: + * </p> * <ul> * <li> {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension} since version 2.0 replacing the original * notification mechanism.</li> @@ -32,7 +33,6 @@ package org.eclipse.jface.text; * notification mechanisms. Thus, implementers up-to-date with version 3.0 do not have to implement * {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension}.</li> * </ul> - * </p> * @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension * @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension2 * @see org.eclipse.jface.text.IDocument diff --git a/org.eclipse.text/src/org/eclipse/jface/text/ISlaveDocumentManager.java b/org.eclipse.text/src/org/eclipse/jface/text/ISlaveDocumentManager.java index 910853c2cdf..784b67cc6c6 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/ISlaveDocumentManager.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/ISlaveDocumentManager.java @@ -28,11 +28,11 @@ package org.eclipse.jface.text; * In order to provided backward compatibility for clients of <code>ISlaveDocumentManager</code>, extension * interfaces are used to provide a means of evolution. The following extension interfaces * exist: + * </p> * <ul> * <li> {@link org.eclipse.jface.text.ISlaveDocumentManagerExtension} since version 3.0 extending the protocol * with an access to all managed slave document for a given master document. </li> * </ul> - * </p> * * @see org.eclipse.jface.text.IDocument * @since 2.1 diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java index 9cc3cd69720..058d6822489 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java @@ -29,6 +29,7 @@ import org.eclipse.jface.text.Position; * In order to provide backward compatibility for clients of <code>IAnnotationModel</code>, extension * interfaces are used to provide a means of evolution. The following extension interfaces * exist: + * </p> * <ul> * <li> {@link org.eclipse.jface.text.source.IAnnotationModelExtension} since version 3.0 introducing the concept * of model piggybacking annotation models, modification time stamps, and enhanced manipulation methods. @@ -37,7 +38,6 @@ import org.eclipse.jface.text.Position; * annotations within a given region. * </li> * </ul> - * </p> * * Clients may implement this interface or use the default implementation provided * by <code>AnnotationModel</code>. diff --git a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html index 34ffca9d1ee..00fe64dc3dc 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html +++ b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html @@ -76,8 +76,6 @@ extension point.</li> <li><tt>TemplatePreferencePage</tt> allows the user to access the templates within a <tt>TemplateStore.</tt></li> </ul> -<ul> -</ul> <h4>Example</h4> See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br> </body> diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html index b5d87c80d63..ba11f535417 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html @@ -14,9 +14,9 @@ with the Eclipse text editor template support. <h2>Templates</h2> <h3>Packages</h3> <ul> - <li><tt><big><strong>org.eclipse.jface.text.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.workbench.texteditor.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.editors.templates</strong></big></tt></li> + <li><code>org.eclipse.jface.text.templates</code></li> + <li><code>org.eclipse.ui.workbench.texteditor.templates</code></li> + <li><code>org.eclipse.ui.editors.templates</code></li> </ul> <h3>Introduction</h3> Templates are shortcuts for frequently used fragments of text such as @@ -69,8 +69,6 @@ extension point.</li> <li><tt>TemplatePreferencePage</tt> allows the user to access the templates within a <tt>TemplateStore.</tt></li> </ul> -<ul> -</ul> <h4>Example</h4> See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br> </body> diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html index b5d87c80d63..ba11f535417 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html @@ -14,9 +14,9 @@ with the Eclipse text editor template support. <h2>Templates</h2> <h3>Packages</h3> <ul> - <li><tt><big><strong>org.eclipse.jface.text.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.workbench.texteditor.templates</strong></big></tt></li> - <li><tt><big><strong>org.eclipse.ui.editors.templates</strong></big></tt></li> + <li><code>org.eclipse.jface.text.templates</code></li> + <li><code>org.eclipse.ui.workbench.texteditor.templates</code></li> + <li><code>org.eclipse.ui.editors.templates</code></li> </ul> <h3>Introduction</h3> Templates are shortcuts for frequently used fragments of text such as @@ -69,8 +69,6 @@ extension point.</li> <li><tt>TemplatePreferencePage</tt> allows the user to access the templates within a <tt>TemplateStore.</tt></li> </ul> -<ul> -</ul> <h4>Example</h4> See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br> </body> |