webapp: convert malformed javadoc to comments

Classes do not have @param or @return tags. The comments describe the request/response not the java code.
eclipse-platform · Nov 8, 2023 · d37d5eb · d37d5eb
1 parent 9a8ef47
commit d37d5eb
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 57 deletions.
diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AboutService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AboutService.java
@@ -35,7 +35,7 @@
 import org.osgi.framework.Bundle;
 import org.osgi.framework.FrameworkUtil;
 
-/**
+/*
  * Generates either xml, json or html page having informations about either
  * <code>User-Agent</code>, Help system <code>preferences</code> or the available
  * plug-ins in Help system like Provider, Plugin name, Version and PluginId.
@@ -59,10 +59,7 @@
  * @return		Informations about either <code>User-Agent</code>, <code>preferences</code>
  * 				or the available plug-ins, either as <code>xml</code> (default) or
  * 				<code>html</code> or <code>json</code>
- *
- * @version	$Version$
- *
- **/
+ */
 public class AboutService extends AboutServlet {
 
 	private static final long serialVersionUID = 1L;

diff --git a/...lipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AdvancedSearchService.java b/...lipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AdvancedSearchService.java
@@ -32,7 +32,7 @@
 import org.eclipse.help.internal.webapp.utils.SearchXMLGenerator;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns the search hits in <code>xml</code> or <code>json</code>
  * form for the query provided in the <code>searchWord</code> parameter.
  *
@@ -60,9 +60,6 @@
  *
  * @return		The search hits, either as <code>xml</code> (default) or
  * 				<code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class AdvancedSearchService extends HttpServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContentService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContentService.java
@@ -31,7 +31,7 @@
 import org.eclipse.help.internal.base.util.ProxyUtil;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns an HTML page for the selected topic passed as request path info.
  *
  * <p>Passes the request to {@link org.eclipse.help.internal.webapp.servlet.ContentServlet}
@@ -40,9 +40,6 @@
  * @param lang	- (optional) specifies the locale
  *
  * @return		An html page for the selected topic
- *
- * @version	$Version$
- *
  **/
 public class ContentService extends HttpServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContextService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContextService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.ContextServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns a context help entry with the id specified in the
  * <code>id</code> parameter in <code>xml</code> or <code>json</code> form.
  *
@@ -49,9 +49,6 @@
  *
  * @exception	400 Error - If context <code>id</code> parameter is missing
  * @exception	404 Error - If wrong context <code>id</code> parameter
- *
- * @version	$Version$
- *
  **/
 public class ContextService extends ContextServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ControlService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ControlService.java
@@ -15,7 +15,7 @@
 
 import org.eclipse.help.internal.webapp.servlet.ControlServlet;
 
-/**
+/*
  * Controls Eclipse help application from standalone application. This
  * service do not allow remote clients to control Eclipse help application.
  *
@@ -27,9 +27,6 @@
  * 						| install | update | enable | disable | uninstall
  * 						| search | listFeatures | addSite | removeSite
  * 						| apply
- *
- * @version	$Version$
- *
  **/
 public class ControlService extends ControlServlet {
 

diff --git a/...rg.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ExtensionService.java b/...rg.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ExtensionService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.ExtensionServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns all topic extensions available on this host in <code>xml</code>
  * or <code>json</code> form.
  *
@@ -44,9 +44,6 @@
  *
  * @return		All topic extensions available on this host, either as
  * 				<code>xml</code> (default) or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class ExtensionService extends ExtensionServlet {
 

diff --git a/...clipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java b/...clipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns <code>xml</code> or <code>json</code> representing selected parts
  * of the index.
  *
@@ -58,9 +58,6 @@
  *
  * @return		Selected parts of the index, either as <code>xml</code>
  * 				(default) or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class IndexFragmentService extends IndexFragmentServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.IndexServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns all available keyword index data in <code>xml</code>
  * or <code>json</code> form. The data is sent as one large index
  * contribution that includes all merged contributions from the system.
@@ -45,9 +45,6 @@
  *
  * @return		All available keyword index data, either as <code>xml</code>
  * 				(default) or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class IndexService extends IndexServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/LiveHelpService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/LiveHelpService.java
@@ -15,7 +15,7 @@
 
 import org.eclipse.help.internal.webapp.servlet.LiveHelpServlet;
 
-/**
+/*
  * Handles the live help action requests with the specified
  * <code>pluginID</code>, <code>class</code> and respective <code>args</code>.
  *
@@ -26,9 +26,6 @@
  * @param class			- specifying the class
  * @param arg			- (Optional) specifying the arguments for the
  * 						  live help extension
- *
- * @version	$Version$
- *
  **/
 public class LiveHelpService extends LiveHelpServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/NavService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/NavService.java
@@ -38,7 +38,7 @@
 import org.eclipse.help.internal.webapp.servlet.XMLGenerator;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Generates either xml, json or html page having navigation informations where topic
  * is not present in the table of contents for the selected toc passed as request
  * path info. Displays links to the direct child topics.
@@ -56,9 +56,6 @@
  * @return	A navigation information having the links to the direct child topics for
  * 			the selected toc, either as <code>xml</code> (default) or
  * 			<code>html</code> or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class NavService extends NavServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/SearchService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/SearchService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.SearchServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns the search hits in <code>xml</code> or <code>json</code>
  * form for the query provided in the <code>phrase</code> parameter.
  *
@@ -45,9 +45,6 @@
  *
  * @return		The search hits, either as <code>xml</code> (default) or
  * 				<code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class SearchService extends SearchServlet {
 

diff --git a/....eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/SearchStateService.java b/....eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/SearchStateService.java
@@ -24,7 +24,7 @@
 import org.eclipse.help.internal.webapp.data.UrlUtil;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns <code>xml</code> or <code>String</code> representing search progress monitor
  *
  * @param lang			- (optional) specifies the locale
@@ -34,9 +34,6 @@
  *
  * @return		Search progress monitor state, either as <code>xml</code>
  * or <code>String</code> (default)
- *
- * @version	$Version$
- *
  **/
 public class SearchStateService extends HttpServlet {
 

diff --git a/....eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/TocFragmentService.java b/....eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/TocFragmentService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.TocFragmentServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns <code>xml</code> or <code>json</code> representing selected parts
  * of one or more TOCs  depending on the parameters.
  *
@@ -50,9 +50,6 @@
  *
  * @return		The selected parts of one or more TOCs, either as <code>xml</code>
  * (default) or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class TocFragmentService extends TocFragmentServlet {
 

diff --git a/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/TocService.java b/ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/TocService.java
@@ -26,7 +26,7 @@
 import org.eclipse.help.internal.webapp.servlet.TocServlet;
 import org.eclipse.help.internal.webapp.utils.Utils;
 
-/**
+/*
  * Returns <code>xml</code> or <code>json</code> representing all toc contributions
  * available on this host
  *
@@ -44,9 +44,6 @@
  *
  * @return		Toc contributions available on the host, either as <code>xml</code>
  * (default) or <code>json</code>
- *
- * @version	$Version$
- *
  **/
 public class TocService extends TocServlet {