diff options
author | Alexander Kurtakov | 2019-02-16 15:04:20 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-16 15:04:20 +0000 |
commit | 5022557f3c9c7735813111b5c2a0d7ff07f8b12e (patch) | |
tree | 93fe1bf6d3ef3d47cae3d42be02c7e4bf5dc5277 | |
parent | bd41efff8beecfdd9c83f1f3a8125177b474be9d (diff) | |
download | eclipse.platform.text-5022557f3c9c7735813111b5c2a0d7ff07f8b12e.tar.gz eclipse.platform.text-5022557f3c9c7735813111b5c2a0d7ff07f8b12e.tar.xz eclipse.platform.text-5022557f3c9c7735813111b5c2a0d7ff07f8b12e.zip |
Bug 543933 - Build javadocs with Java 11I20190218-0600I20190217-1800I20190217-0600I20190216-1800
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: I9d4dfa7c57b47c5d130c8d0c50069b0ed15b70fa
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
8 files changed, 118 insertions, 106 deletions
diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/IContextMenuConstants.java b/org.eclipse.search/new search/org/eclipse/search/ui/IContextMenuConstants.java index 6ead79c663b..5099b1efb67 100644 --- a/org.eclipse.search/new search/org/eclipse/search/ui/IContextMenuConstants.java +++ b/org.eclipse.search/new search/org/eclipse/search/ui/IContextMenuConstants.java @@ -29,50 +29,54 @@ import org.eclipse.ui.IWorkbenchActionConstants; public interface IContextMenuConstants { /** - * Pop-up menu: name of group for goto actions (value <code>"group.open"</code>). + * Pop-up menu: name of group for goto actions (value + * <code>"group.open"</code>). * <p> * Examples for open actions are: + * </p> * <ul> - * <li>Go Into</li> - * <li>Go To</li> + * <li>Go Into</li> + * <li>Go To</li> * </ul> - * </p> */ public static final String GROUP_GOTO= "group.goto"; //$NON-NLS-1$ /** - * Pop-up menu: name of group for open actions (value <code>"group.open"</code>). + * Pop-up menu: name of group for open actions (value + * <code>"group.open"</code>). * <p> * Examples for open actions are: + * </p> * <ul> - * <li>Open To</li> - * <li>Open With</li> + * <li>Open To</li> + * <li>Open With</li> * </ul> - * </p> */ public static final String GROUP_OPEN= "group.open"; //$NON-NLS-1$ /** - * Pop-up menu: name of group for show actions (value <code>"group.show"</code>). + * Pop-up menu: name of group for show actions (value + * <code>"group.show"</code>). * <p> * Examples for show actions are: + * </p> * <ul> - * <li>Show in Navigator</li> - * <li>Show in Type Hierarchy</li> + * <li>Show in Navigator</li> + * <li>Show in Type Hierarchy</li> * </ul> - * </p> */ public static final String GROUP_SHOW= "group.show"; //$NON-NLS-1$ /** - * Pop-up menu: name of group for new actions (value <code>"group.new"</code>). + * Pop-up menu: name of group for new actions (value + * <code>"group.new"</code>). * <p> * Examples for new actions are: + * </p> * <ul> - * <li>Create new class</li> - * <li>Create new interface</li> + * <li>Create new class</li> + * <li>Create new interface</li> * </ul> - * </p> */ public static final String GROUP_NEW= "group.new"; //$NON-NLS-1$ diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java b/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java index 45878ad8e0c..01310e7e571 100644 --- a/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java +++ b/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java @@ -1417,21 +1417,27 @@ public abstract class AbstractTextSearchViewPage extends Page implements ISearch } /** - * Sets the maximal number of top level elements to be shown in a viewer. - * If <code>null</code> is set, the view page does not support to limit the elements and will not provide - * UI to configure it. If a non-null value is set, configuration UI will be provided. The limit value must be a positive - * number or <code>-1</code> to not limit top level element. - * If enabled, the element limit has to be enforced by the content provider that is implemented by the client. The view - * page just manages the value and configuration. + * Sets the maximal number of top level elements to be shown in a viewer. If + * <code>null</code> is set, the view page does not support to limit the + * elements and will not provide UI to configure it. If a non-null value is + * set, configuration UI will be provided. The limit value must be a + * positive number or <code>-1</code> to not limit top level element. If + * enabled, the element limit has to be enforced by the content provider + * that is implemented by the client. The view page just manages the value + * and configuration. * - * @param limit the element limit. Valid values are: - * <dl> - * <li><code>null</code> to not limit and not provide configuration UI</li> - * <li><code>-1</code> to not limit and provide configuration UI</li> - * <li><code>positive integer</code> to limit by the given value and provide configuration UI</li> - * </dl> + * @param limit + * the element limit. Valid values are: + * <ul> + * <li><code>null</code> to not limit and not provide + * configuration UI</li> + * <li><code>-1</code> to not limit and provide configuration + * UI</li> + * <li><code>positive integer</code> to limit by the given value + * and provide configuration UI</li> + * </ul> * - * @since 3.3 + * @since 3.3 */ public void setElementLimit(Integer limit) { fElementLimit= limit; @@ -1446,18 +1452,22 @@ public abstract class AbstractTextSearchViewPage extends Page implements ISearch /** * Gets the maximal number of top level elements to be shown in a viewer. - * <code>null</code> means the view page does not limit the elements and will not provide - * UI to configure it. If a non-null value is set, configuration UI will be provided. The limit value must be a positive + * <code>null</code> means the view page does not limit the elements and + * will not provide UI to configure it. If a non-null value is set, + * configuration UI will be provided. The limit value must be a positive * number or <code>-1</code> to not limit top level element. * * @return returns the element limit. Valid values are: - * <dl> - * <li><code>null</code> to not limit and not provide configuration UI (default value)</li> - * <li><code>-1</code> to not limit and provide configuration UI</li> - * <li><code>positive integer</code> to limit by the given value and provide configuration UI</li> - * </dl> + * <ul> + * <li><code>null</code> to not limit and not provide configuration + * UI (default value)</li> + * <li><code>-1</code> to not limit and provide configuration + * UI</li> + * <li><code>positive integer</code> to limit by the given value and + * provide configuration UI</li> + * </ul> * - * @since 3.3 + * @since 3.3 */ public Integer getElementLimit() { return fElementLimit; diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/text/package.html b/org.eclipse.search/new search/org/eclipse/search/ui/text/package.html index f1bb90d0fa3..687eb1f0019 100644 --- a/org.eclipse.search/new search/org/eclipse/search/ui/text/package.html +++ b/org.eclipse.search/new search/org/eclipse/search/ui/text/package.html @@ -8,11 +8,11 @@ Provides the base classes to implement a search result view part for searches wi <h2> Package Specification</h2> -<tt>AbstractTextSearchResult</tt> implements a <tt>ISearchResult</tt> and holds result entries of type <tt>Match</tt>. A match represents a range of text in +<code>AbstractTextSearchResult</code> implements a <code>ISearchResult</code> and holds result entries of type <code>Match</code>. A match represents a range of text in a parent resource. -<p><tt>AbstractTextSearchViewPage</tt> implements a <tt>ISearchResultPage</tt> capable of showing an <tt>AbstractTextSearchResult</tt>. -It uses <tt>IEditorMatchAdapter</tt>, <tt>IFileMatchAdapter</tt> to adapt matches to editor, resp. files. -<p> Editors that don't use standard text annotation models can implement <tt>ISearchEditorAccess</tt> to allow textual searches +<p><code>AbstractTextSearchViewPage</code> implements a <code>ISearchResultPage</code> capable of showing an <code>AbstractTextSearchResult</code>. +It uses <code>IEditorMatchAdapter</code>, <code>IFileMatchAdapter</code> to adapt matches to editor, resp. files. +<p> Editors that don't use standard text annotation models can implement <code>ISearchEditorAccess</code> to allow textual searches to be shown. </body></html>
\ No newline at end of file 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 3aadf457283..e74f7c772ab 100644 --- a/org.eclipse.search/search/org/eclipse/search/ui/package.html +++ b/org.eclipse.search/search/org/eclipse/search/ui/package.html @@ -18,33 +18,33 @@ and search result view pages (extension point 'org.eclipse.search.searchResultVi <h3> Search dialog pages</h3> -<p>Search dialog pages contributing to the 'searchPages' extension point must implement <tt>ISearchPage</tt>. A search page -has access to its <tt>ISearchPageContainer</tt> to modify search +<p>Search dialog pages contributing to the 'searchPages' extension point must implement <code>ISearchPage</code>. A search page +has access to its <code>ISearchPageContainer</code> to modify search dialog properties. -<p>A search dialog page can additionally implement <tt>IReplacePage</tt> to allow the 'Replace' button to show up. +<p>A search dialog page can additionally implement <code>IReplacePage</code> to allow the 'Replace' button to show up. <h3> 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>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>. +<p>On 'OK', an implementation of a search dialog page creates a <i>search query</i>, represented by an instances of type <code>ISearchQuery</code>. The query +can be run using API on <code>NewSearchUI</code> and will create a <code>ISearchResult</code> as result. +<code>ISearchResultListener</code> can be added to search results and report changes as <code>SearchResultEvent</code>. -<p>Clients have to contribute a search result page (<tt>ISearchResultPage</tt>) that can +<p>Clients have to contribute a search result page (<code>ISearchResultPage</code>) that can visualize the matches contained in the result set. -<p>The result page has access to the view using <tt>ISearchResultViewPart</tt> +<p>The result page has access to the view using <code>ISearchResultViewPart</code> <h3> 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>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>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> (<code>org.eclipse.core.resources.IMarker</code>, 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>. +<p>The search dialog page (type <code>ISearchResultView</code>) could access the single search result view using <code>SearchUI.getSearchResultView()</code>. It showed all matches as elements of type <code>ISearchResultViewEntry</code>. -<p><tt>IGroupByKeyComputer</tt>, <tt>IActionGroupFactory</tt>, <tt>IContextMenuContributor</tt> and extension point +<p><code>IGroupByKeyComputer</code>, <code>IActionGroupFactory</code>, <code>IContextMenuContributor</code> and extension point 'org.eclipse.search.searchResultSorters' were used to configure the search result view. diff --git a/org.eclipse.text/src/org/eclipse/text/edits/CopyingRangeMarker.java b/org.eclipse.text/src/org/eclipse/text/edits/CopyingRangeMarker.java index 17e3b6534a5..61f2f62d5cc 100644 --- a/org.eclipse.text/src/org/eclipse/text/edits/CopyingRangeMarker.java +++ b/org.eclipse.text/src/org/eclipse/text/edits/CopyingRangeMarker.java @@ -28,7 +28,7 @@ public final class CopyingRangeMarker extends TextEdit { private String fText; /** - * Creates a new <tt>CopyRangeMarker</tt> for the given + * Creates a new <code>CopyRangeMarker</code> for the given * offset and length. * * @param offset the marker's offset diff --git a/org.eclipse.text/src/org/eclipse/text/edits/package.html b/org.eclipse.text/src/org/eclipse/text/edits/package.html index 769057d167b..738f733f9b5 100644 --- a/org.eclipse.text/src/org/eclipse/text/edits/package.html +++ b/org.eclipse.text/src/org/eclipse/text/edits/package.html @@ -9,20 +9,20 @@ <body> Provides support for describing and applying textual document editions. <p> -A complex textual edition can be described by a tree of <tt>TextEdit</tt>s. An edit -can be applied to an <tt>IDocument</tt> by calling <tt>TextEdit.apply</tt> or by -using a <tt>TextEditProcessor</tt>. Applying a text edit can record a reverse edit +A complex textual edition can be described by a tree of <code>TextEdit</code>s. An edit +can be applied to an <code>IDocument</code> by calling <code>TextEdit.apply</code> or by +using a <code>TextEditProcessor</code>. Applying a text edit can record a reverse edit description that can be used to undo the edition. </p> Use the standard edit kinds to describe the basic document editing operations: <ul> - <li><em>replace</em> a document range: <tt>ReplaceEdit</tt></li> - <li><em>delete</em> a document range: <tt>DeleteEdit</tt></li> - <li><em>insert</em> text: <tt>InsertEdit</tt></li> - <li><em>track</em> a range while the document is being modified: <tt>RangeMarker</tt></li> + <li><em>replace</em> a document range: <code>ReplaceEdit</code></li> + <li><em>delete</em> a document range: <code>DeleteEdit</code></li> + <li><em>insert</em> text: <code>InsertEdit</code></li> + <li><em>track</em> a range while the document is being modified: <code>RangeMarker</code></li> </ul> <p> -Other subclasses of <tt>TextEdit</tt> exist for specialized tasks. Use <tt>MultiTextEdit</tt> to +Other subclasses of <code>TextEdit</code> exist for specialized tasks. Use <code>MultiTextEdit</code> to compose a complex edit tree, or subclass it to provide a custom edit. </p> </body></html>
\ No newline at end of file diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java index 22ea76eec72..95c092604f0 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java @@ -87,24 +87,22 @@ public final class EditorsUI { } /** - * Removes all preference which are handled by this plug-in's - * general preference pages from the given store and prevents - * setting the default values in the future. + * Removes all preference which are handled by this plug-in's general preference pages from the + * given store and prevents setting the default values in the future. * <p> - * To access the - * general preference from another plug-in use a + * To access the general preference from another plug-in use a * {@link org.eclipse.ui.texteditor.ChainedPreferenceStore}: + * </p> + * * <pre> - * List stores= new ArrayList(3); - * stores.add(YourPlugin.getDefault().getPreferenceStore()); - * stores.add(EditorsUI.getPreferenceStore()); - * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); + * List stores= new ArrayList(3); + * stores.add(YourPlugin.getDefault().getPreferenceStore()); + * stores.add(EditorsUI.getPreferenceStore()); + * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); * * </pre> - * </p> * <p> - * Note: In order to work this method must be called before - * the store's default values are set. + * Note: In order to work this method must be called before the store's default values are set. * </p> * * @param store the preference store to mark @@ -114,24 +112,22 @@ public final class EditorsUI { } /** - * Removes all preference which are handled by this plug-in's - * Quick Diff preference page from the given store and prevents - * setting the default values in the future. + * Removes all preference which are handled by this plug-in's Quick Diff preference page from + * the given store and prevents setting the default values in the future. * <p> - * To access the - * general preference from another plug-in use a + * To access the general preference from another plug-in use a * {@link org.eclipse.ui.texteditor.ChainedPreferenceStore}: + * </p> + * * <pre> - * List stores= new ArrayList(3); - * stores.add(YourPlugin.getDefault().getPreferenceStore()); - * stores.add(EditorsUI.getPreferenceStore()); - * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); + * List stores= new ArrayList(3); + * stores.add(YourPlugin.getDefault().getPreferenceStore()); + * stores.add(EditorsUI.getPreferenceStore()); + * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); * * </pre> - * </p> * <p> - * Note: In order to work this method must be called before - * the store's default values are set. + * Note: In order to work this method must be called before the store's default values are set. * </p> * * @param store the preference store to mark diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java index ce86a6c82ef..728c83c2789 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/AbstractTextEditor.java @@ -2032,7 +2032,9 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit * </p> * * <p> - * The following preferences can be used for fine-grained configuration when enabled. + * The following preferences can be used for fine-grained configuration when + * enabled. + * </p> * <ul> * <li>{@link #PREFERENCE_SHOW_LEADING_SPACES}</li> * <li>{@link #PREFERENCE_SHOW_ENCLOSED_SPACES}</li> @@ -2047,7 +2049,6 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit * <li>{@link #PREFERENCE_SHOW_LINE_FEED}</li> * <li>{@link #PREFERENCE_WHITESPACE_CHARACTER_ALPHA_VALUE}</li> * </ul> - * </p> * * @since 3.3 */ @@ -3276,18 +3277,19 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit /** * The <code>AbstractTextEditor</code> implementation of this - * <code>IWorkbenchPart</code> method creates the vertical ruler and - * source viewer. + * <code>IWorkbenchPart</code> method creates the vertical ruler and source + * viewer. * <p> * Subclasses may extend this method. Besides extending this method, the - * behavior of <code>createPartControl</code> may be customized by - * calling, extending or replacing the following methods: <br> + * behavior of <code>createPartControl</code> may be customized by calling, + * extending or replacing the following methods: <br> * Subclasses may supply customized implementations for some members using * the following methods before <code>createPartControl</code> is invoked: + * </p> * <ul> - * <li> - * {@linkplain #setSourceViewerConfiguration(SourceViewerConfiguration) setSourceViewerConfiguration} - * to supply a custom source viewer configuration,</li> + * <li>{@linkplain #setSourceViewerConfiguration(SourceViewerConfiguration) + * setSourceViewerConfiguration} to supply a custom source viewer + * configuration,</li> * <li>{@linkplain #setRangeIndicator(Annotation) setRangeIndicator} to * provide a range indicator,</li> * <li>{@linkplain #setHelpContextId(String) setHelpContextId} to provide a @@ -3303,29 +3305,29 @@ public abstract class AbstractTextEditor extends EditorPart implements ITextEdit * <ul> * <li>{@linkplain #createVerticalRuler() createVerticalRuler} to supply a * custom vertical ruler,</li> - * <li>{@linkplain #createSourceViewer(Composite, IVerticalRuler, int) createSourceViewer} - * to supply a custom source viewer,</li> - * <li>{@linkplain #getSelectionProvider() getSelectionProvider} to supply - * a custom selection provider.</li> + * <li>{@linkplain #createSourceViewer(Composite, IVerticalRuler, int) + * createSourceViewer} to supply a custom source viewer,</li> + * <li>{@linkplain #getSelectionProvider() getSelectionProvider} to supply a + * custom selection provider.</li> * </ul> * <br> * Subclasses may extend the following methods called from within * <code>createPartControl</code>: * <ul> - * <li> - * {@linkplain #initializeViewerColors(ISourceViewer) initializeViewerColors} - * to customize the viewer color scheme (may also be replaced),</li> - * <li> - * {@linkplain #initializeDragAndDrop(ISourceViewer) initializeDragAndDrop} - * to customize drag and drop (may also be replaced),</li> + * <li>{@linkplain #initializeViewerColors(ISourceViewer) + * initializeViewerColors} to customize the viewer color scheme (may also be + * replaced),</li> + * <li>{@linkplain #initializeDragAndDrop(ISourceViewer) + * initializeDragAndDrop} to customize drag and drop (may also be + * replaced),</li> * <li>{@linkplain #createNavigationActions() createNavigationActions} to * add navigation actions,</li> * <li>{@linkplain #createActions() createActions} to add text editor * actions.</li> * </ul> - * </p> * - * @param parent the parent composite + * @param parent + * the parent composite */ @Override public void createPartControl(Composite parent) { |