diff options
author | Alexander Kurtakov | 2019-02-16 10:17:30 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-16 10:17:30 +0000 |
commit | bdffa0c5390963cfeb67c58712173774bc8fd4e9 (patch) | |
tree | 42edb7e20ea548e017bf73c58f0daa5b9621e0f5 | |
parent | 07e8871767065e1065e6f55656417510b9dee5b3 (diff) | |
download | eclipse.platform.ua-bdffa0c5390963cfeb67c58712173774bc8fd4e9.tar.gz eclipse.platform.ua-bdffa0c5390963cfeb67c58712173774bc8fd4e9.tar.xz eclipse.platform.ua-bdffa0c5390963cfeb67c58712173774bc8fd4e9.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: Ic3ebad9640e7483979a183aff0807663456ed193
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
5 files changed, 29 insertions, 26 deletions
diff --git a/org.eclipse.help.base/src/org/eclipse/help/search/ISearchEngineResult.java b/org.eclipse.help.base/src/org/eclipse/help/search/ISearchEngineResult.java index 8a0ea8617..d48c3a2bd 100644 --- a/org.eclipse.help.base/src/org/eclipse/help/search/ISearchEngineResult.java +++ b/org.eclipse.help.base/src/org/eclipse/help/search/ISearchEngineResult.java @@ -61,24 +61,24 @@ public interface ISearchEngineResult { * @return the URL (as a string) associated with the resource * <p> * Valid URL of a help resource is: + * </p> * <ul> * <li>a <em>/pluginID/path/to/resource</em>, where * <ul> * <li><em>pluginID</em> is the unique identifier of the plugin * containing the help resource, - * <li><em>path/to/document</em> is the help resource path, - * relative to the plugin directory. + * <li><em>path/to/document</em> is the help resource path, relative + * to the plugin directory. * </ul> * For example. <em>/myplugin/mytoc.xml</em> or * <em>/myplugin/references/myclass.html</em> are vaild. - * <li>string representation of URI to an external document. In - * this case, all special characters have to be enoded such that the - * URI is appropriate to be opened with a web browser. + * <li>string representation of URI to an external document. In this + * case, all special characters have to be enoded such that the URI + * is appropriate to be opened with a web browser. * <em>http://eclipse.org/documents/my%20file.html</em> and * <em>jar:file:/c:/my%20sources/src.zip!/mypackage/MyClass.html</em> * are examples of valid URIs. * </ul> - * </p> */ String getHref(); diff --git a/org.eclipse.help.base/src/org/eclipse/help/search/SearchParticipant.java b/org.eclipse.help.base/src/org/eclipse/help/search/SearchParticipant.java index 2f18e40ef..39178f6f7 100644 --- a/org.eclipse.help.base/src/org/eclipse/help/search/SearchParticipant.java +++ b/org.eclipse.help.base/src/org/eclipse/help/search/SearchParticipant.java @@ -104,23 +104,26 @@ public abstract class SearchParticipant { ISearchDocument doc); /** - * Returns all the documents that this participant knows about. This method is only used for - * participants that handle documents outside of the help system's TOC. + * Returns all the documents that this participant knows about. This method + * is only used for participants that handle documents outside of the help + * system's TOC. * * @param locale * the index locale * - * @return a set<String> of hrefs for documents managed by this participant. + * @return a Set of String of hrefs for documents managed by this + * participant. */ public Set<String> getAllDocuments(String locale) { return EMPTY_SET; } /** - * Returns a set of identifiers of plug-ins that contribute indexable documents. This method is - * only used for participants that handle documents outside of the help system's TOC. + * Returns a set of identifiers of plug-ins that contribute indexable + * documents. This method is only used for participants that handle + * documents outside of the help system's TOC. * - * @return a set<String> of contributing plug-in ids + * @return a Set of String of contributing plug-in ids */ public Set<String> getContributingPlugins() { diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/RootScopePage.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/RootScopePage.java index d0432b16b..807e8c54f 100644 --- a/org.eclipse.help.ui/src/org/eclipse/help/ui/RootScopePage.java +++ b/org.eclipse.help.ui/src/org/eclipse/help/ui/RootScopePage.java @@ -210,7 +210,7 @@ public abstract class RootScopePage extends PreferencePage implements * Tests whether the search engine has been selected to participate in the * search. * - * @return <code>true</code> if the search engine is enabled, </code>false</code> + * @return <code>true</code> if the search engine is enabled, <code>false</code> * otherwise. */ diff --git a/org.eclipse.help/src/org/eclipse/help/IHelp.java b/org.eclipse.help/src/org/eclipse/help/IHelp.java index 9d56b2112..0dd473870 100644 --- a/org.eclipse.help/src/org/eclipse/help/IHelp.java +++ b/org.eclipse.help/src/org/eclipse/help/IHelp.java @@ -157,21 +157,21 @@ public interface IHelp { public void displayHelp(String toc); /** - * This method is an extension to the <a - * href="#displayHelp(java.lang.String)">displayHelp(String toc) </a> + * This method is an extension to the + * <a href="#displayHelp(java.lang.String)">displayHelp(String toc) </a> * method, providing the ability to open the specified help topic. * <p> - * <code>selectedTopic</code> should be a valid help topic url contained - * in the specified <code>toc</code> and have the following format: + * <code>selectedTopic</code> should be a valid help topic url contained in + * the specified <code>toc</code> and have the following format: * <em>/pluginID/path_to_document</em><br> * where + * </p> * <dl> - * <dt><em>pluginID</em> is the unique identifier of the plugin - * containing the help topic,</dt> + * <dt><em>pluginID</em> is the unique identifier of the plugin containing + * the help topic,</dt> * <dt><em>path_to_document</em> is the help topic path, relative to the * plugin directory</dt> * </dl> - * </p> * * @param toc * the URL of the toc diff --git a/org.eclipse.help/src/org/eclipse/help/IHelpResource.java b/org.eclipse.help/src/org/eclipse/help/IHelpResource.java index 2da0164b4..d77294e08 100644 --- a/org.eclipse.help/src/org/eclipse/help/IHelpResource.java +++ b/org.eclipse.help/src/org/eclipse/help/IHelpResource.java @@ -38,24 +38,24 @@ public interface IHelpResource { * @return the URL (as a string) associated with the resource * <p> * Valid URL of a help resource is: + * </p> * <ul> * <li>a <em>/pluginID/path/to/resource</em>, where * <ul> * <li><em>pluginID</em> is the unique identifier of the plugin * containing the help resource, - * <li><em>path/to/document</em> is the help resource path, - * relative to the plugin directory. + * <li><em>path/to/document</em> is the help resource path, relative + * to the plugin directory. * </ul> * For example. <em>/myplugin/mytoc.xml</em> or * <em>/myplugin/references/myclass.html</em> are vaild. - * <li>string representation of URI to an external document. In - * this case, all special characters have to be enoded such that the - * URI is appropriate to be opened with a web browser. + * <li>string representation of URI to an external document. In this + * case, all special characters have to be enoded such that the URI + * is appropriate to be opened with a web browser. * <em>http://eclipse.org/documents/my%20file.html</em> and * <em>jar:file:/c:/my%20sources/src.zip!/mypackage/MyClass.html</em> * are examples of valid URIs. * </ul> - * </p> */ public String getHref(); /** |