Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-18 10:39:28 +0000
committerAlexander Kurtakov2019-02-18 10:39:28 +0000
commitcd9e6f42e7560d59789a36ebced59b09959af8cc (patch)
treec07eb2c6926b3ccfa622465263e290ba008f2b5c /org.eclipse.help.base
parentbdffa0c5390963cfeb67c58712173774bc8fd4e9 (diff)
downloadeclipse.platform.ua-cd9e6f42e7560d59789a36ebced59b09959af8cc.tar.gz
eclipse.platform.ua-cd9e6f42e7560d59789a36ebced59b09959af8cc.tar.xz
eclipse.platform.ua-cd9e6f42e7560d59789a36ebced59b09959af8cc.zip
Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool with XDoclint:html. Change-Id: I5574e0e981e4780edc2b4bb5a65d8fef0bad26a6 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.help.base')
-rw-r--r--org.eclipse.help.base/src/org/eclipse/help/browser/package.html10
-rw-r--r--org.eclipse.help.base/src/org/eclipse/help/search/package.html8
-rw-r--r--org.eclipse.help.base/src/org/eclipse/help/standalone/package.html4
3 files changed, 11 insertions, 11 deletions
diff --git a/org.eclipse.help.base/src/org/eclipse/help/browser/package.html b/org.eclipse.help.base/src/org/eclipse/help/browser/package.html
index 8113b78be..e0b9d8b0d 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/browser/package.html
+++ b/org.eclipse.help.base/src/org/eclipse/help/browser/package.html
@@ -16,26 +16,26 @@ Base Help System, requires web browser to display help document.&nbsp; Since
availability of web browsers differ from system to system, it is possible
to configure browser adapters in addition to ones provided with the base.&nbsp;
The browser (or browser adapter) can be configured by
-providing extension for <tt>org.eclipse.help.base.browser</tt> extension point.&nbsp;
+providing extension for <code>org.eclipse.help.base.browser</code> extension point.&nbsp;
If more than one browser is available on a user system, the default browser
can be designated in Help preference page.
<p>In general terms, implementing a web browser involves:
<ul>
<li>
-Implementing standalone UI element having the <tt>IBrowser</tt> API, and
+Implementing standalone UI element having the <code>IBrowser</code> API, and
capable of displaying HTML documents given a URL.</li>
<li>
Providing a factory for managing of browsers on a particular system, by
-implementing <tt>IBrowserFactory</tt> interface.</li>
+implementing <code>IBrowserFactory</code> interface.</li>
<li>
-Declaring an extension of the <tt>org.eclipse.help.base.browser</tt> extension
+Declaring an extension of the <code>org.eclipse.help.base.browser</code> extension
point that mentions the name of that factory class.</li>
</ul>
Note that browser factory will be created on every system.&nbsp; If the
factory is not capable of creating a browser on some system configurations,
-due to missing prerequisites e.t.c., its <tt>isAvailable()</tt> method
+due to missing prerequisites e.t.c., its <code>isAvailable()</code> method
should be returning false on these systems.
</body>
diff --git a/org.eclipse.help.base/src/org/eclipse/help/search/package.html b/org.eclipse.help.base/src/org/eclipse/help/search/package.html
index 75d21272d..80b1e325c 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/search/package.html
+++ b/org.eclipse.help.base/src/org/eclipse/help/search/package.html
@@ -15,10 +15,10 @@ for creating search indices.
<h2>Package Specification</h2>
<p>This package contains the API for adding content to the help search functionality
and is responsible for indexing all contents of the help system. To add content, a
-plug-in must extend the <tt>SearchParticipant</tt> abstract class and point to it
-using the <tt>org.eclipse.help.search.searchParticipant</tt> extension point.</p>
-<p>The package also provides an abstract class that extends <tt>LuceneSearchParticipant</tt>
-called <tt>SearchParticipantXML</tt> which adds functionality for parsing XML
+plug-in must extend the <code>SearchParticipant</code> abstract class and point to it
+using the <code>org.eclipse.help.search.searchParticipant</code> extension point.</p>
+<p>The package also provides an abstract class that extends <code>LuceneSearchParticipant</code>
+called <code>SearchParticipantXML</code> which adds functionality for parsing XML
documents.</p>
</body>
diff --git a/org.eclipse.help.base/src/org/eclipse/help/standalone/package.html b/org.eclipse.help.base/src/org/eclipse/help/standalone/package.html
index a97d264cc..4a7a26926 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/standalone/package.html
+++ b/org.eclipse.help.base/src/org/eclipse/help/standalone/package.html
@@ -14,8 +14,8 @@ they are intended to be called from outside of Eclipse environment.
<h2>
Package Specification</h2>The help system in Eclipse can be used to run an information center or as a stand alone help system for use by other products.&nbsp; Access
to the help system is provided
-<TT>org.eclipse.help.standalone.Infocenter </TT> and
-<TT>org.eclipse.help.standalone.Help </TT>
+<code>org.eclipse.help.standalone.Infocenter </code> and
+<code>org.eclipse.help.standalone.Help </code>
classes.
<P>To start or stop the information center, use the Infocenter class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.</P>
<p>To start, stop the stand alone help system or cause it to display help on a user machine, use the Help class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.</P>

Back to the top