Bug 548250 - Javadoc problems in platform.ua
Change-Id: I4fc959485fcb2ee5b20c4099c0f08532e66669da
Signed-off-by: Paul Pazderski <paul-eclipse@ppazderski.de>
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/base/HelpDisplay.java b/org.eclipse.help.base/src/org/eclipse/help/internal/base/HelpDisplay.java
index 9e72762..3bf0fdc 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/base/HelpDisplay.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/base/HelpDisplay.java
@@ -151,7 +151,7 @@
* Display help to search view for given query and selected topic.
*
* @param searchQuery
- * search query in URL format key=value&key=value
+ * search query in URL format {@literal key=value&key=value }
* @param topic
* selected from the search results
*/
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/PreferenceFileHandler.java b/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/PreferenceFileHandler.java
index 0d9e25e..589d741 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/PreferenceFileHandler.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/PreferenceFileHandler.java
@@ -139,8 +139,7 @@
/**
* This methods writes the remote infocenters in the table model to the preferences.ini.
*
- * @param List
- * of RemoteIC Objects
+ * @param remoteICs List of RemoteIC Objects
*
*/
public static void commitRemoteICs(RemoteIC[] remoteICs) {
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaBrowserAdapter.java b/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaBrowserAdapter.java
index 78d97e6..4cada2e 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaBrowserAdapter.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaBrowserAdapter.java
@@ -54,8 +54,8 @@
/**
* Constructor
*
- * @executable executable filename to launch
- * @executableName name of the program to display when error occurs
+ * @param executable executable filename to launch
+ * @param executableName name of the program to display when error occurs
*/
MozillaBrowserAdapter(String executable, String executableName) {
this.uiThread = Thread.currentThread();
@@ -181,12 +181,11 @@
/**
* On some OSes 0 is always returned by netscape -remote. It is
- * necessary to examine ouput to find out failure
+ * necessary to examine output to find out failure
*
* @param outputs
* @param errors
- * @return @throws
- * InterruptedException
+ * @return
*/
private boolean errorsInOutput(StreamConsumer outputs, StreamConsumer errors) {
try {
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaFactory.java b/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaFactory.java
index 40fe868..34d8b5f 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaFactory.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/browser/MozillaFactory.java
@@ -63,12 +63,11 @@
}
/**
* On some OSes 0 is always returned by "which" command it is necessary to
- * examine ouput to find out failure.
+ * examine output to find out failure.
*
* @param outputs
* @param errors
- * @return @throws
- * InterruptedException
+ * @return
*/
private boolean errorsInOutput(StreamConsumer outputs, StreamConsumer errors) {
try {
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/Analyzer_en.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/Analyzer_en.java
index 7c32fce..8a277e5 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/Analyzer_en.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/Analyzer_en.java
@@ -28,7 +28,7 @@
/**
* Lucene Analyzer for English.
- * LowerCaseAndDigitsTokenizer->StopFilter->PorterStemFilter
+ * LowerCaseAndDigitsTokenizer->StopFilter->PorterStemFilter
*/
public final class Analyzer_en extends Analyzer {
/**
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/DefaultAnalyzer.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/DefaultAnalyzer.java
index 6e76215..fff84df 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/DefaultAnalyzer.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/DefaultAnalyzer.java
@@ -29,7 +29,7 @@
/**
- * Lucene Analyzer. LowerCaseFilter->StandardTokenizer
+ * Lucene Analyzer. LowerCaseFilter->StandardTokenizer
*/
public final class DefaultAnalyzer extends Analyzer {
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/HTMLDocParser.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/HTMLDocParser.java
index 82eb8ad..c978caa 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/HTMLDocParser.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/HTMLDocParser.java
@@ -127,7 +127,9 @@
/**
* Private. Parses HTML to extract document encoding specified in HTTP
* equivalent META tag in the document header. Example of such META tag is
+ * <pre>{@code
* <META HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
+ * }</pre>
*
* @return String or null if encoding not found
*/
diff --git a/org.eclipse.help.base/src_demo/org/apache/lucene/demo/html/ParseException.java b/org.eclipse.help.base/src_demo/org/apache/lucene/demo/html/ParseException.java
index d0bf3bf..6a78fe8 100644
--- a/org.eclipse.help.base/src_demo/org/apache/lucene/demo/html/ParseException.java
+++ b/org.eclipse.help.base/src_demo/org/apache/lucene/demo/html/ParseException.java
@@ -37,7 +37,9 @@
* This constructor calls its super class with the empty string
* to force the "toString" method of parent class "Throwable" to
* print the error message in the form:
+ * <pre>{@code
* ParseException: <result of getMessage>
+ * }</pre>
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,
diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/preferences/ICTable.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/preferences/ICTable.java
index 99c7f90..c3a3d41 100644
--- a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/preferences/ICTable.java
+++ b/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/preferences/ICTable.java
@@ -188,7 +188,7 @@
/**
- * @param rics the ordered remote InfoCenters
+ * @param ics the ordered remote InfoCenters
*/
public void update(List<IC> ics) {
viewer.getContentProvider().inputChanged(viewer, null, ics);
diff --git a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/util/EscapeUtils.java b/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/util/EscapeUtils.java
index db84f99..cf1ef02 100644
--- a/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/util/EscapeUtils.java
+++ b/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/util/EscapeUtils.java
@@ -22,7 +22,7 @@
public class EscapeUtils {
/**
- * Replace every occurrence of &, <, >, ', " by an escape character
+ * Replace every occurrence of {@code &, <, >, ', "} by an escape character
* Replace tabs with spaces
* @param value the original string, may not be null
* @return the escaped string
@@ -32,7 +32,7 @@
}
/**
- * Replace every occurrence of &, <, >, ', " by an escape character
+ * Replace every occurrence of {@code &, <, >, ', "} by an escape character
* but allow <b> and </b> through
* Replace tabs with spaces
* @param value the original string, may not be null
@@ -47,8 +47,8 @@
}
/**
- * Escape any ampersands used in a label
- **/
+ * Escape any ampersands used in a label
+ */
public static String escapeForLabel(String message) {
// Make the most common case - i.e. no ampersand the
// most efficient
diff --git a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/ServletResources.java b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/ServletResources.java
index 7166ff0..8c64123 100644
--- a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/ServletResources.java
+++ b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/ServletResources.java
@@ -95,7 +95,7 @@
/**
* Returns a string from a property file, with underlined access key. Access
- * key can be specified in the label by &: character following character
+ * key can be specified in the label by & character following character
* in the label that is to serve as access key It uses 'name' as a the key
* to retrieve from the webapp.properties file.
*
diff --git a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/BreadcrumbsFilter.java b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/BreadcrumbsFilter.java
index 532e8c6..3d820f6 100644
--- a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/BreadcrumbsFilter.java
+++ b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/BreadcrumbsFilter.java
@@ -31,7 +31,7 @@
/**
* Injects breadcrumbs at the top of help documents, e.g.
- * "Workbench User Guide > Concepts > Workbench".
+ * "Workbench User Guide > Concepts > Workbench".
*/
public class BreadcrumbsFilter implements IFilter {
diff --git a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/CookieUtil.java b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/CookieUtil.java
index f208dcf..023116b 100644
--- a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/CookieUtil.java
+++ b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/CookieUtil.java
@@ -149,8 +149,8 @@
/**
* Saves string in multiple browser cookies. Cookies can store limited
- * length string. This method will attemt to split string among multiple
- * cookies. The following cookies will be set name1=length <substing1
+ * length string. This method will attempt to split string among multiple
+ * cookies. The following cookies will be set name1=length <substing1
* name2=substring2 ... namen=substringn
*
* @param data
diff --git a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/InfocenterWorkingSetManager.java b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/InfocenterWorkingSetManager.java
index d220d6d..023ab05 100644
--- a/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/InfocenterWorkingSetManager.java
+++ b/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/InfocenterWorkingSetManager.java
@@ -241,7 +241,7 @@
/***************************************************************************
* Persists all working sets. Should only be called by the webapp working
* set dialog. Saves the working sets in the persistence store (cookie)
- * format: curentWorkingSetName|name1&href11&href12|name2&href22
+ * format: {@literal curentWorkingSetName|name1&href11&href12|name2&href22}
*/
private void saveState() throws IOException {
saveContents();
diff --git a/org.eclipse.help/META-INF/MANIFEST.MF b/org.eclipse.help/META-INF/MANIFEST.MF
index 49a0c54..40fbfe1 100644
--- a/org.eclipse.help/META-INF/MANIFEST.MF
+++ b/org.eclipse.help/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@
Bundle-ManifestVersion: 2
Bundle-Name: %help_plugin_name
Bundle-SymbolicName: org.eclipse.help; singleton:=true
-Bundle-Version: 3.8.500.qualifier
+Bundle-Version: 3.8.600.qualifier
Bundle-Activator: org.eclipse.help.internal.HelpPlugin
Bundle-Vendor: %providerName
Bundle-Localization: plugin
diff --git a/org.eclipse.help/pom.xml b/org.eclipse.help/pom.xml
index 2e859ef..a6e7efa 100644
--- a/org.eclipse.help/pom.xml
+++ b/org.eclipse.help/pom.xml
@@ -18,7 +18,7 @@
</parent>
<groupId>org.eclipse.help</groupId>
<artifactId>org.eclipse.help</artifactId>
- <version>3.8.500-SNAPSHOT</version>
+ <version>3.8.600-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
<properties>
diff --git a/org.eclipse.help/src/org/eclipse/help/internal/context/IStyledContext.java b/org.eclipse.help/src/org/eclipse/help/internal/context/IStyledContext.java
index 2d66986..aa6f86b 100644
--- a/org.eclipse.help/src/org/eclipse/help/internal/context/IStyledContext.java
+++ b/org.eclipse.help/src/org/eclipse/help/internal/context/IStyledContext.java
@@ -27,7 +27,7 @@
/**
* Returns the text description for this context with bold markers
*
- * @return String with <@#$b>and </@#$b> to mark bold range (as
+ * @return String with {@literal <@#$b> and </@#$b>} to mark bold range (as
* IContext.getText() used to in 2.x)
*/
public String getStyledText();
diff --git a/org.eclipse.tips.core/META-INF/MANIFEST.MF b/org.eclipse.tips.core/META-INF/MANIFEST.MF
index 64a1a21..6668106 100644
--- a/org.eclipse.tips.core/META-INF/MANIFEST.MF
+++ b/org.eclipse.tips.core/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.tips.core;singleton:=true
-Bundle-Version: 0.1.500.qualifier
+Bundle-Version: 0.1.600.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Export-Package: org.eclipse.tips.core,
diff --git a/org.eclipse.tips.core/pom.xml b/org.eclipse.tips.core/pom.xml
index 4436567..c941239 100644
--- a/org.eclipse.tips.core/pom.xml
+++ b/org.eclipse.tips.core/pom.xml
@@ -22,6 +22,6 @@
</parent>
<groupId>org.eclipse.ui</groupId>
<artifactId>org.eclipse.tips.core</artifactId>
- <version>0.1.500-SNAPSHOT</version>
+ <version>0.1.600-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/org.eclipse.tips.core/src/org/eclipse/tips/core/TipProvider.java b/org.eclipse.tips.core/src/org/eclipse/tips/core/TipProvider.java
index 32d5774..a9f4193 100644
--- a/org.eclipse.tips.core/src/org/eclipse/tips/core/TipProvider.java
+++ b/org.eclipse.tips.core/src/org/eclipse/tips/core/TipProvider.java
@@ -241,7 +241,7 @@
/**
* Get a list of tips filtered by the passed predicate.
*
- * @param a {@link Predicate} targeting a Tip object or null to return all tips
+ * @param predicate a {@link Predicate} targeting a Tip object or null to return all tips
* @return an unmodifiable list of tips.
*/
public synchronized List<Tip> getTips(Predicate<Tip> predicate) {
diff --git a/org.eclipse.tips.json/src/org/eclipse/tips/json/internal/JsonHTMLTip.java b/org.eclipse.tips.json/src/org/eclipse/tips/json/internal/JsonHTMLTip.java
index d65f21f..f59a9b7 100644
--- a/org.eclipse.tips.json/src/org/eclipse/tips/json/internal/JsonHTMLTip.java
+++ b/org.eclipse.tips.json/src/org/eclipse/tips/json/internal/JsonHTMLTip.java
@@ -37,7 +37,7 @@
private JsonObject fJsonObject;
/**
- * Creates the tip out od the passed Json object.
+ * Creates the tip out of the passed Json object.
*
* @param jsonObject the json object
* @param provider the provider
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java
index 9523e40..cf6bf99 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java
@@ -200,7 +200,7 @@
* is a good guideline to follow).
* </p>
*
- * @return an <code>ArrayList<code> of cheatsheet items <code>CheatSheetElement</code>
+ * @return an <code>ArrayList</code> of cheatsheet items <code>CheatSheetElement</code>
*/
protected ArrayList<CheatSheetElement> getCheatSheetItems() {
ArrayList<CheatSheetElement> list = new ArrayList<>(MAX_CHEATSHEET_ITEMS);
@@ -309,9 +309,9 @@
/**
* Sets the showActive flag. If <code>showActive == true</code> then the
- * active cheatsheet is hilighted with a check mark.
+ * active cheatsheet is highlighted with a check mark.
*
- * @param the new showActive flag
+ * @param b the new showActive flag
*/
protected void showActive(boolean b) {
showActive = b;
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java
index c30892f..81d619a 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java
@@ -23,22 +23,29 @@
private Set<ICompositeCheatSheetTask> stateChangedTasks;
private Set<ICompositeCheatSheetTask> impactedTasks;
+
/**
- * Find which tasks have either become blocked or unblocked so that they
- * can be added to the list of change events.
- * @param stateChangedTasks The set of tasks which has changed
+ * Find which tasks have either become blocked or unblocked so that they can
+ * be added to the list of change events.
+ *
+ * @param stateChangedTasks
+ * The set of tasks which has changed
* @return The set of tasks which have become blocked or unblocked by the
- * change of state and were not in the original set. The algorithm will sometimes add tasks to
- * the result set which were not actually impacted but this is not a major problem
- * since it only means that extra events get sent to the explorer. For updates other
- * than resets the number of extra events is very low.
- *
- * This takes several steps.
- * <li> If a group is completed, skipped or reset add any non-started children.
- * <li> Determine all successors of tasks whose state has changed that are not in the change set
- * <li> Add the successor and its children to the list if not started
+ * change of state and were not in the original set. The algorithm
+ * will sometimes add tasks to the result set which were not
+ * actually impacted but this is not a major problem since it only
+ * means that extra events get sent to the explorer. For updates
+ * other than resets the number of extra events is very low.
+ * <p>
+ * This takes several steps.
+ * <ul>
+ * <li>If a group is completed, skipped or reset add any non-started
+ * children.
+ * <li>Determine all successors of tasks whose state has changed
+ * that are not in the change set
+ * <li>Add the successor and its children to the list if not started
+ * </ul>
*/
-
public Set<ICompositeCheatSheetTask> findBlockedTaskChanges(Set<ICompositeCheatSheetTask> stateChangedTasks) {
this.stateChangedTasks = stateChangedTasks;
impactedTasks = new HashSet<>();
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java
index 91f6c53..c813201 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java
@@ -102,12 +102,14 @@
/**
* Check for circular dependencies using the following algorithm.
- * 1. Create a set of all the tasks which have an id (tasks without id cannot be in a cycle).;
- * 2. Remove from the set any tasks which depend on no other task, these cannot be part of a cycle
- * 3. Remove from the set any tasks which only depend on tasks already removed, these cannot be
+ * <ol>
+ * <li>Create a set of all the tasks which have an id (tasks without id cannot be in a cycle).;
+ * <li>Remove from the set any tasks which depend on no other task, these cannot be part of a cycle
+ * <li>Remove from the set any tasks which only depend on tasks already removed, these cannot be
* part of a cycle.
- * 4. Repeat step 3 until not further tasks can be removed
- * 5. Any tasks remaining are part of a cycle or depend on a task in a cycle
+ * <li>Repeat step 3 until not further tasks can be removed
+ * <li>Any tasks remaining are part of a cycle or depend on a task in a cycle
+ * </ol>
* @param model
* @param status
*/
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java
index b2e8867..ab8e1f8 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java
@@ -91,8 +91,8 @@
/**
* Indicates this action is to be used if and only if the value of the condition attribute
- * of the containing <perform-when> element matches this string value. This attribute is
- * ignored if the <action> element is not a child of a <perform-when> element.
+ * of the containing {@literal <perform-when>} element matches this string value. This attribute is
+ * ignored if the {@literal <action>} element is not a child of a {@literal <perform-when>} element.
* @param when The expression to use when determine if this action should be used.
*/
public void setWhen(String when) {
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java
index f18a52c..53a6e38 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java
@@ -21,7 +21,7 @@
import org.w3c.dom.Node;
/**
- * Class that represents an <ACTION> element in a cheatsheet. This class stores all
+ * Class that represents an {@literal <ACTION>} element in a cheatsheet. This class stores all
* of the attributes associated with an Action and is capable of executing that Action.
*/
public class Action extends AbstractExecutable {
@@ -54,7 +54,7 @@
/**
* This method allows you to specify the class to be run when the perform button is pressed for this
* item in the cheat sheet.
- * @param classname the class to be run by the item in the cheat sheet
+ * @param aclass the class to be run by the item in the cheat sheet
*/
public void setClass(String aclass) {
this.actionClass = aclass;
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java
index 98bd50a..80a48f3 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java
@@ -105,20 +105,27 @@
}
/**
- * Converts any characters required to escaped by an XML parser to
- * their escaped counterpart.
+ * Converts any characters required to escaped by an XML parser to their
+ * escaped counterpart.
*
- * Characters XML escaped counterpart
- * < -> <
- * > -> >
- * & -> &
- * ' -> '
- * " -> "
+ * <pre>
+ * {@code
+ * Characters XML escaped counterpart
+ * < -> <
+ * > -> >
+ * & -> &
+ * ' -> '
+ * " -> "
+ * }
+ * </pre>
+ *
+ * Tags that will be ignored {@literal <b>, </b> and <br/>
+ * }.
*
- * Tags that will be ignored <b>, </b> and <br/>.
- *
- * @param text the string buffer to have its characters escaped
- * @return string buffer with any of the characters requiring XML escaping escaped
+ * @param text
+ * the string buffer to have its characters escaped
+ * @return string buffer with any of the characters requiring XML escaping
+ * escaped
*/
private StringBuilder escapeXMLCharacters(StringBuilder text) {
// Set the maximum length of the tags to ignore
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java
index 39d28e4..9919825 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java
@@ -84,7 +84,7 @@
}
/**
- * @param Executable The Executable to set.
+ * @param executable The Executable to set.
*/
@Override
public void setExecutable(AbstractExecutable executable) {
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java
index 7093cb9..7d933fd 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java
@@ -83,9 +83,9 @@
* the specified configuration element.
*
* @param configElement
- * the <code>IConfigurationElement<code> containing
+ * the <code>IConfigurationElement</code> containing
* the ID, label, and optional parent category path.
- * @throws WorkbenchException if the ID or label is <code>null</code
+ * @throws WorkbenchException if the ID or label is <code>null</code>
*/
public Category(IConfigurationElement configElement)
throws WorkbenchException {
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java
index d901c85..37ba636 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java
@@ -23,7 +23,7 @@
/**
* A Viewer element sorter that sorts Elements by their name attribute.
* Note that capitalization differences are not considered by this
- * sorter, so a < B < c.
+ * sorter, so a < B < c.
*/
public class CheatSheetCollectionSorter extends ViewerComparator {
public final static CheatSheetCollectionSorter INSTANCE = new CheatSheetCollectionSorter();
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java
index 0905ff8..2d2685d 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java
@@ -102,7 +102,7 @@
/**
* Returns the part's unique identifier.
*
- * @param the unique id for the part
+ * @return the unique id for the part
*/
@Override
public String getId() {
@@ -145,7 +145,7 @@
/**
* Sets the visibility of the part.
*
- * @param whether or not the part should be visible
+ * @param visible whether or not the part should be visible
*/
@Override
public void setVisible(boolean visible) {
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java
index cb8b24b..557e1b9 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java
@@ -105,7 +105,7 @@
}
/**
- * Creates the cheatsheet's title areawhich will consists of a title and
+ * Creates the cheatsheet's title area which will consists of a title and
* image.
*
* @param parent
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java
index a4c1ade..91e7d6a 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java
@@ -78,6 +78,7 @@
* </p>
* <p>
* For implementors this is a multi-step process:
+ * </p>
* <ol>
* <li>Create one or more controls within the parent.</li>
* <li>Set the parent layout as needed.</li>
@@ -86,7 +87,6 @@
* <li>Register a selection provider with the <code>ISelectionService</code>
* (optional). </li>
* </ol>
- * </p>
*
* @param parent the parent control
*/
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java
index dcb8195..2605eca 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java
@@ -612,6 +612,7 @@
* </p>
* <p>
* For implementors this is a multi-step process:
+ * </p>
* <ol>
* <li>Create one or more controls within the parent.</li>
* <li>Set the parent layout as needed.</li>
@@ -620,7 +621,6 @@
* <li>Register a selection provider with the <code>ISelectionService</code>
* (optional). </li>
* </ol>
- * </p>
*
* @param parent the parent control
*/
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java
index 9ab6ca9..94669eb 100644
--- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java
+++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java
@@ -131,7 +131,7 @@
}
/**
- * Creates the cheatsheet's title areawhich will consists
+ * Creates the cheatsheet's title area which will consists
* of a title and image.
*
* @param parent the SWT parent for the title area composite
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java
index 5e81ae8..f9c552f 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java
@@ -22,8 +22,10 @@
*/
public final class HTMLUtil {
/**
- * Creates an HTML opening element of the form <elementName
- * elementAttributes>
+ * Creates an HTML opening element of the form
+ * <pre>{@code
+ * <elementName elementAttributes>
+ * }</pre>
*
* @param elementName
* the name of the element to create
@@ -52,7 +54,10 @@
}
/**
- * Creates an HTML start tag of the form <elementName>
+ * Creates an HTML start tag of the form
+ * <pre>{@code
+ * <elementName>
+ * }</pre>
*
* @param elementName
* the name of the element to create
@@ -66,8 +71,11 @@
}
/**
- * Creates an HTML start tag of the form <elementName>and inserts a line
- * break after the start tag
+ * Creates an HTML start tag of the form
+ * <pre>{@code
+ * <elementName>
+ * }</pre>
+ * and inserts a line break after the start tag
*
* @param elementName
* the name of the element to create
@@ -78,7 +86,10 @@
}
/**
- * Creates an HTML closing element of the form </elementName>
+ * Creates an HTML closing element of the form
+ * <pre>{@code
+ * </elementName>
+ * }</pre>
*
* @param elementName
* the name of the closing element to create
@@ -98,7 +109,7 @@
/**
* Given a map of attribute names and values, this method will create a
- * StringBuilder of the attributes in the form: attrName="attrValue". These
+ * StringBuilder of the attributes in the form: <code>attrName="attrValue"</code>. These
* attributes can appear in the start tag of an HTML element.
*
* @param attributes
@@ -125,7 +136,7 @@
}
/**
- * Creates an HTML attribute of the form attrName="attrValue"
+ * Creates an HTML attribute of the form <code>attrName="attrValue"</code>
*
* @param attrName
* the name of the attribute
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java
index dbeef38..e4bbef2 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java
@@ -1205,13 +1205,12 @@
* An example usage of the string substution: The html file <code>inline.html</code> is
* included in your intro via the html inline mechanism . This file needs to reference a
* resource that is located in another plugin. The following might be found in inline.html:
- * <code>
+ * {@code
* <a href="$plugin:test.plugin$html/test.html">link to file</a>
- * </code> When this file
- * is read in, the relevant section will be replaced as follows: <code>
+ * } When this file
+ * is read in, the relevant section will be replaced as follows: {@code
* <a href="file:/install_path/plugins/test.plugin/html/test.html">link to file</a>
- * </code>
- *
+ * }
*/
private static class PluginIdParser {
@@ -1241,7 +1240,7 @@
/**
* This method should be called after the initial substitution identifier has been read in
* (the substition string begins and ends with the "$" character). A properly formatted
- * substitution string is of the form:</code> "$plugin:plugin_id$</code>- the initial "$"
+ * substitution string is of the form: <code>"$plugin:plugin_id$</code>- the initial "$"
* is immediately followed by the "plugin:" segment - the <code>plugin_id </code> refers to
* a valid, installed plugin - the substitution string is terminated by a closing "$" If the
* above conditions are not met, no substitution occurs. If the above conditions are met,
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java
index 5004763..a4c6421 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java
@@ -382,7 +382,7 @@
/**
* Find the target element pointed to by the path in the include. It is
* assumed that configId always points to an external config, and not the
- * same config of the inlcude.
+ * same config of the include.
*
* @param include
* @param path
@@ -579,13 +579,13 @@
/**
* Creates a clone of the given target node. A clone is create by simply
- * recreating that protion of the model.
+ * recreating that portion of the model.
*
* Note: looked into the clonable interface in Java, but it was not used
* because it makes modifications/additions to the model harder to maintain.
* Will revisit later.
*
- * @param targer
+ * @param target
* @return
*/
protected AbstractIntroElement cloneTarget(AbstractIntroElement target) {
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java
index e36f8ac..c9269fb 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java
@@ -411,7 +411,7 @@
/**
- * Override parent behavior to add support for HEAD & Title element in pages
+ * Override parent behavior to add support for HEAD & Title element in pages
* only, and not in divs.
*
* @see org.eclipse.ui.internal.intro.impl.model.AbstractIntroContainer#getModelChild(org.eclipse.core.runtime.IConfigurationElement)
@@ -642,12 +642,14 @@
/**
* Resolves the full page. It is called just before the page needs to be
* displayed.
+ * <ul>
* <li>adds a BASE child to the DOM HEAD element, if one is not defined.
* All intro documents must have a base defined to resolve all urls.</li>
* <li>resolves all includes in the page. This means importing target DOM.
* </li>
* <li>resolves all XHTML attributes for resources, eg: src, href
* attributes.</li>
+ * </ul>
*/
protected void resolvePage() {
// insert base meta-tag,
@@ -725,7 +727,7 @@
/**
* Find the target Element pointed to by the path in the include. It is
* assumed that configId always points to an external config, and not the
- * same config of the inlcude.
+ * same config of the include.
*
* @param include
* @param path
@@ -759,7 +761,7 @@
* @param results
* two object array that will return the target intro page as the
* first result, and the actual target DOM Element as the second
- * result. It is gauranteed to not be null. Content may be null.
+ * result. It is guaranteed to not be null. Content may be null.
* @return target DOM element
*/
public Object[] findDOMTarget(IntroModelRoot model, String path) {
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java
index fbde4a2..fda4b9f 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java
@@ -54,7 +54,7 @@
* <li>if an attribute is not included in the markup, its value will be null in
* the model.</li>
* <li>Resources in plugin.xml are not implicitly resolved against $nl$.
- * Resources in pages are implicitly resolved against $nl$
+ * Resources in pages are implicitly resolved against $nl$</li>
* <li>the current page id is set silently when loading the model. You do not
* need the event notification on model load.</li>
* <li>Children of a given parent (ie: model root, page, or group) *must* have
@@ -76,10 +76,10 @@
* the group in the page as a path. Again this is because extensions extends
* anchors that already have a path, not a resolved path.</li>
* <li>Pages and shared groups that are contributed through extensions become
- * children of the atrget configuration, and so any includes they may have will
+ * children of the target configuration, and so any includes they may have will
* be resolved correctly.</li>
* <li>An infinite loop can occur if page A includes from page B and page B in
- * turn includes from page A. ie: cyclic includes. For performnace, accept.
+ * turn includes from page A. ie: cyclic includes. For performance, accept.
* </li>
* <li>When resolving includes, if the target is a container, it must be
* resolved to resolve its includes correctly. Otherwise, included includes will
@@ -94,12 +94,11 @@
* is a must, null the DOM class instance the minute you are done. This is
* because you want the VM to garbage collect the DOM model. Keeping a reference
* to the DOM model from the Intro model will prevent that.</li>
- * </ol>
* <li>(since 3.0.2) several passes are used to resolve contributions to
* anchors that themselves where contributed through an extension. Each time a
* contribution is resolved, the model tries to resolve all unresolved
- * contribution, recursively.
- * </ul>
+ * contribution, recursively.</li>
+ * </ol>
*/
public class IntroModelRoot extends AbstractIntroContainer {
@@ -150,7 +149,7 @@
}
/**
- * Model root. Takes a configElement that represents <config>in the
+ * Model root. Takes a configElement that represents {@literal <config>} in the
* plugin.xml markup AND all the extension contributed to this model through
* the configExtension point.
*/
@@ -661,7 +660,7 @@
/**
- * Updates the inherited styles based on the style attribtes defined in the
+ * Updates the inherited styles based on the style attributes defined in the
* configExtension. If we are extending a shared group do nothing. For
* inherited alt-styles, we have to cache the bundle from which we inherited
* the styles to be able to access resources in that plugin.
@@ -773,8 +772,8 @@
* Sets the current page. If the model does not have a page with the passed
* id, the message is logged, and the model retains its old current page.
*
- * @param currentPageId
- * The currentPageId to set. *
+ * @param pageId
+ * The currentPageId to set.
* @param fireEvent
* flag to indicate if event notification is needed.
* @return true if the model has a page with the passed id, false otherwise.
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java
index 41666fd..79fb718 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java
@@ -46,12 +46,12 @@
* <li>ID attribute of this model class is the id of the picked implementation element.</li>
* <li>Style attribute in this model class is the style of the picked implementation element.</li>
* <li>HTMLHeadContent in this model class is the HEAD element under the picked implementation
- * element, only if the implementation element is a Browser implmenetation.</li>
+ * element, only if the implementation element is a Browser implementation.</li>
* <li>The UI model class, AbstractIntroPartImplementation, that represents the IntroPart
* implementation is cached here for quick access. It is used by intro url actions for manipulation
* of UI.<br>
* INTRO:This really should be in a UI model class.
- * <ul>
+ * </ul>
*/
public class IntroPartPresentation extends AbstractIntroElement {
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroText.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroText.java
index 46f0a37..ee3faba 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroText.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroText.java
@@ -61,7 +61,7 @@
}
/**
- * @return true if the content of this text element has any " <" which makes
+ * @return true if the content of this text element has any "<" which makes
* it formatted.
*/
public boolean checkIfFormatted() {
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java
index 7d5f13c..56bb898 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java
@@ -24,8 +24,8 @@
import org.eclipse.ui.intro.config.IIntroContentProviderSite;
/**
- * Class for handling/caching all the loaded Intro Content providers, from all loaded models. <br>
- * <br />
+ * Class for handling/caching all the loaded Intro Content providers, from all loaded models.
+ * <p>
* Design notes:
* <ul>
* <li>content providers are only ever created once. The init method is only called once, and so
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java
index e310432..1450740 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java
@@ -20,7 +20,7 @@
/**
* Manages all Intro plugin extension points. Currently, there are two:
- * org.eclipse.ui.intro.config & org.eclipse.ui.intro.configExtension. <br>
+ * org.eclipse.ui.intro.config & org.eclipse.ui.intro.configExtension. <br>
* The model is lazily loaded on per need basis. This happens when a page is
* asked for its children, or when the model is trying to resolve includes or
* extensions. <br>
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java
index 1a2383d..dc442ea 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java
@@ -67,7 +67,7 @@
* Checks to see if the passed string is a valid URL (has a protocol), if
* yes, returns it as is. If no, treats it as a resource relative to the
* declaring plugin. Return the plugin relative location, fully qualified.
- * Retruns null if the passed string itself is null.
+ * Returns null if the passed string itself is null.
*
* @param resource
* @param pluginDesc
@@ -87,7 +87,7 @@
* Checks to see if the passed string is a valid URL (has a protocol), if
* yes, returns it as is. If no, treats it as a resource relative to the
* declaring plugin. Return the plugin relative location, fully qualified.
- * Retruns null if the passed string itself is null.
+ * Returns null if the passed string itself is null.
*
* @param resource
* @param pluginDesc
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java
index a1950bd..5486e75 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java
@@ -243,10 +243,9 @@
/**
* Finds the description text of the given group. Looks for the Text child
* element whos id is specified as follows:
- * <p>
- * <pageId>. <path_to_group>.description-id= <id of child description Text
- * element>
- * </p>
+ * <pre>{@code
+ * <pageId>. <path_to_group>.description-id= <id of child description Text element>
+ * }</pre>
* If not found, use the default description style.
*
* Returns null if no default style found, or any id in path is null.
@@ -266,9 +265,9 @@
/**
* Finds the description text of the associated page. Looks for the Text
* child element whos id is specified as follows:
- * <p>
+ * <pre>{@code
* <pageId>.description-id= <id of child description Text element>
- * </p>
+ * }</pre>
* If not found, use the default description style.
*
* Returns null if no default style found, or any id in path is null.
@@ -301,9 +300,9 @@
/**
* Finds the subtitle of the associated page. Looks for the Text child
* element whose id is specified as follows:
- * <p>
+ * <pre>{@code
* <pageId>.description-id= <id of child description Text element>
- * </p>
+ * }</pre>
* If not found, use the default description style.
*
* @param group
