Skip to content

Commit d37d5eb

Browse files
EcljpseB0Tjukzi
authored andcommitted
webapp: convert malformed javadoc to comments
Classes do not have @param or @return tags. The comments describe the request/response not the java code.
1 parent 9a8ef47 commit d37d5eb

14 files changed

+15
-57
lines changed

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AboutService.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import org.osgi.framework.Bundle;
3636
import org.osgi.framework.FrameworkUtil;
3737

38-
/**
38+
/*
3939
* Generates either xml, json or html page having informations about either
4040
* <code>User-Agent</code>, Help system <code>preferences</code> or the available
4141
* plug-ins in Help system like Provider, Plugin name, Version and PluginId.
@@ -59,10 +59,7 @@
5959
* @return Informations about either <code>User-Agent</code>, <code>preferences</code>
6060
* or the available plug-ins, either as <code>xml</code> (default) or
6161
* <code>html</code> or <code>json</code>
62-
*
63-
* @version $Version$
64-
*
65-
**/
62+
*/
6663
public class AboutService extends AboutServlet {
6764

6865
private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/AdvancedSearchService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
import org.eclipse.help.internal.webapp.utils.SearchXMLGenerator;
3333
import org.eclipse.help.internal.webapp.utils.Utils;
3434

35-
/**
35+
/*
3636
* Returns the search hits in <code>xml</code> or <code>json</code>
3737
* form for the query provided in the <code>searchWord</code> parameter.
3838
*
@@ -60,9 +60,6 @@
6060
*
6161
* @return The search hits, either as <code>xml</code> (default) or
6262
* <code>json</code>
63-
*
64-
* @version $Version$
65-
*
6663
**/
6764
public class AdvancedSearchService extends HttpServlet {
6865

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContentService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import org.eclipse.help.internal.base.util.ProxyUtil;
3232
import org.eclipse.help.internal.webapp.utils.Utils;
3333

34-
/**
34+
/*
3535
* Returns an HTML page for the selected topic passed as request path info.
3636
*
3737
* <p>Passes the request to {@link org.eclipse.help.internal.webapp.servlet.ContentServlet}
@@ -40,9 +40,6 @@
4040
* @param lang - (optional) specifies the locale
4141
*
4242
* @return An html page for the selected topic
43-
*
44-
* @version $Version$
45-
*
4643
**/
4744
public class ContentService extends HttpServlet {
4845

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ContextService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.eclipse.help.internal.webapp.servlet.ContextServlet;
2727
import org.eclipse.help.internal.webapp.utils.Utils;
2828

29-
/**
29+
/*
3030
* Returns a context help entry with the id specified in the
3131
* <code>id</code> parameter in <code>xml</code> or <code>json</code> form.
3232
*
@@ -49,9 +49,6 @@
4949
*
5050
* @exception 400 Error - If context <code>id</code> parameter is missing
5151
* @exception 404 Error - If wrong context <code>id</code> parameter
52-
*
53-
* @version $Version$
54-
*
5552
**/
5653
public class ContextService extends ContextServlet {
5754

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ControlService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
import org.eclipse.help.internal.webapp.servlet.ControlServlet;
1717

18-
/**
18+
/*
1919
* Controls Eclipse help application from standalone application. This
2020
* service do not allow remote clients to control Eclipse help application.
2121
*
@@ -27,9 +27,6 @@
2727
* | install | update | enable | disable | uninstall
2828
* | search | listFeatures | addSite | removeSite
2929
* | apply
30-
*
31-
* @version $Version$
32-
*
3330
**/
3431
public class ControlService extends ControlServlet {
3532

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/ExtensionService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.eclipse.help.internal.webapp.servlet.ExtensionServlet;
2727
import org.eclipse.help.internal.webapp.utils.Utils;
2828

29-
/**
29+
/*
3030
* Returns all topic extensions available on this host in <code>xml</code>
3131
* or <code>json</code> form.
3232
*
@@ -44,9 +44,6 @@
4444
*
4545
* @return All topic extensions available on this host, either as
4646
* <code>xml</code> (default) or <code>json</code>
47-
*
48-
* @version $Version$
49-
*
5047
**/
5148
public class ExtensionService extends ExtensionServlet {
5249

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexFragmentService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet;
2727
import org.eclipse.help.internal.webapp.utils.Utils;
2828

29-
/**
29+
/*
3030
* Returns <code>xml</code> or <code>json</code> representing selected parts
3131
* of the index.
3232
*
@@ -58,9 +58,6 @@
5858
*
5959
* @return Selected parts of the index, either as <code>xml</code>
6060
* (default) or <code>json</code>
61-
*
62-
* @version $Version$
63-
*
6461
**/
6562
public class IndexFragmentService extends IndexFragmentServlet {
6663

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/IndexService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.eclipse.help.internal.webapp.servlet.IndexServlet;
2727
import org.eclipse.help.internal.webapp.utils.Utils;
2828

29-
/**
29+
/*
3030
* Returns all available keyword index data in <code>xml</code>
3131
* or <code>json</code> form. The data is sent as one large index
3232
* contribution that includes all merged contributions from the system.
@@ -45,9 +45,6 @@
4545
*
4646
* @return All available keyword index data, either as <code>xml</code>
4747
* (default) or <code>json</code>
48-
*
49-
* @version $Version$
50-
*
5148
**/
5249
public class IndexService extends IndexServlet {
5350

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/LiveHelpService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
import org.eclipse.help.internal.webapp.servlet.LiveHelpServlet;
1717

18-
/**
18+
/*
1919
* Handles the live help action requests with the specified
2020
* <code>pluginID</code>, <code>class</code> and respective <code>args</code>.
2121
*
@@ -26,9 +26,6 @@
2626
* @param class - specifying the class
2727
* @param arg - (Optional) specifying the arguments for the
2828
* live help extension
29-
*
30-
* @version $Version$
31-
*
3229
**/
3330
public class LiveHelpService extends LiveHelpServlet {
3431

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/service/NavService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import org.eclipse.help.internal.webapp.servlet.XMLGenerator;
3939
import org.eclipse.help.internal.webapp.utils.Utils;
4040

41-
/**
41+
/*
4242
* Generates either xml, json or html page having navigation informations where topic
4343
* is not present in the table of contents for the selected toc passed as request
4444
* path info. Displays links to the direct child topics.
@@ -56,9 +56,6 @@
5656
* @return A navigation information having the links to the direct child topics for
5757
* the selected toc, either as <code>xml</code> (default) or
5858
* <code>html</code> or <code>json</code>
59-
*
60-
* @version $Version$
61-
*
6259
**/
6360
public class NavService extends NavServlet {
6461

0 commit comments

Comments
 (0)