Fixes eclipse-platform#686 - failing javadoc in org.eclipse.help.base

Signed-off-by: Rob Stryker <stryker@redhat.com>
CodeLtDave · Sep 14, 2023 · f6ccf8b · f6ccf8b
1 parent 08a1cf7
commit f6ccf8b
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 14 deletions.
diff --git a/ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/LocalSearchManager.java b/ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/LocalSearchManager.java
@@ -148,12 +148,11 @@ public void clear() {
 	}
 
 	/**
-	 * Converts the given TopDocs object into a List of raw SearchHits.
-	 * Hits objects are immutable and can't be instantiated from outside
-	 * Lucene.
-	 * @param searcher
+	 * Converts the given TopDocs object into a List of raw SearchHits. Hits objects
+	 * are immutable and can't be instantiated from outside Lucene.
 	 *
-	 * @param hits the TopDocs object to convert
+	 * @param topDocs  the TopDocs object to convert
+	 * @param searcher
 	 * @return a List of raw SearchHits
 	 */
 

diff --git a/ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchIndex.java b/ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchIndex.java
@@ -485,12 +485,12 @@ public synchronized boolean endRemoveDuplicatesBatch() {
 	}
 
 	/**
-	 * If
 	 *
-	 * @param dirs
+	 * @param pluginIndexes
 	 * @param monitor
-	 * @return Map. Keys are /pluginid/href of all merged Docs. Values are null for added document,
-	 *         or String[] of indexIds with duplicates of the document
+	 * @return Map. Keys are /pluginid/href of all merged Docs. Values are null for
+	 *         added document, or String[] of indexIds with duplicates of the
+	 *         document
 	 */
 	public Map<String, String[]> merge(PluginIndex[] pluginIndexes, IProgressMonitor monitor) {
 		ArrayList<NIOFSDirectory> dirList = new ArrayList<>(pluginIndexes.length);

diff --git a/....eclipse.help.base/src/org/eclipse/help/internal/search/federated/FederatedSearchJob.java b/....eclipse.help.base/src/org/eclipse/help/internal/search/federated/FederatedSearchJob.java
@@ -24,9 +24,6 @@ public class FederatedSearchJob extends Job {
 	private final String expression;
 	private final FederatedSearchEntry entry;
 
-	/**
-	 * @param name
-	 */
 	public FederatedSearchJob(String expression, FederatedSearchEntry entry) {
 		super(entry.getEngineName());
 		this.expression = expression;

diff --git a/...rg.eclipse.help.base/src/org/eclipse/help/internal/workingset/IHelpWorkingSetManager.java b/...rg.eclipse.help.base/src/org/eclipse/help/internal/workingset/IHelpWorkingSetManager.java
@@ -47,8 +47,6 @@ public WorkingSet createWorkingSet(String name,
 
 	/**
 	 * Implements IWorkingSetManager.
-	 *
-	 * @see org.eclipse.ui.IWorkingSetManager#getWorkingSets()
 	 */
 	public WorkingSet[] getWorkingSets();
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,8 +47,6 @@ public WorkingSet createWorkingSet(String name, @@
     	/**
     	 * Implements IWorkingSetManager.
-    	 *
-    	 * @see org.eclipse.ui.IWorkingSetManager#getWorkingSets()
     	 */
     	public WorkingSet[] getWorkingSets();
@@ Expand Down @@