From de4b0198b747e714908e064f110239a3b720e806 Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Sun, 30 Jun 2013 17:13:53 +0000
Subject: [PATCH] javadoc fixes
---
apps/BOB/src/net/i2p/BOB/DoCMDS.java | 2 +-
.../src/net/i2p/router/web/PluginStarter.java | 2 +-
.../src/src/i2p/susi/webmail/WebMail.java | 16 ++++++++--------
.../src/i2p/susi/webmail/pop3/POP3MailBox.java | 10 +++++-----
4 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/apps/BOB/src/net/i2p/BOB/DoCMDS.java b/apps/BOB/src/net/i2p/BOB/DoCMDS.java
index 85be6e9ea2..a4708f009c 100644
--- a/apps/BOB/src/net/i2p/BOB/DoCMDS.java
+++ b/apps/BOB/src/net/i2p/BOB/DoCMDS.java
@@ -388,7 +388,7 @@ public class DoCMDS implements Runnable {
* Does the base64 information look OK
*
* @param data
- * @return
+ * @return OK
*/
private boolean is64ok(String data) {
try {
diff --git a/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java b/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
index b7018d37fa..31e8ff0bb5 100644
--- a/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
+++ b/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
@@ -763,7 +763,7 @@ public class PluginStarter implements Runnable {
/**
* Returns <code>true</code> if one or more client threads are running in a given plugin.
* @param pluginName
- * @return
+ * @return true if running
*/
private static boolean isClientThreadRunning(String pluginName) {
ThreadGroup group = pluginThreadGroups.get(pluginName);
diff --git a/apps/susimail/src/src/i2p/susi/webmail/WebMail.java b/apps/susimail/src/src/i2p/susi/webmail/WebMail.java
index 6760e05876..8556c2ef71 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/WebMail.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/WebMail.java
@@ -365,7 +365,7 @@ public class WebMail extends HttpServlet
*
* @param name
* @param label
- * @return
+ * @return the string
*/
private static String sortHeader( String name, String label, String imgPath )
{
@@ -376,7 +376,7 @@ public class WebMail extends HttpServlet
*
* @param request
* @param key
- * @return
+ * @return true if pressed
*/
private static boolean buttonPressed( RequestWrapper request, String key )
{
@@ -530,7 +530,7 @@ public class WebMail extends HttpServlet
* - quote html tags
*
* @param line
- * @return
+ * @return escaped string
*/
private static String quoteHTML( String line )
{
@@ -870,7 +870,7 @@ public class WebMail extends HttpServlet
}
/**
* @param request
- * @return
+ * @return message number or -1
*/
private static int getCheckedMessage(RequestWrapper request) {
for( Enumeration e = request.getParameterNames(); e.hasMoreElements(); ) {
@@ -1039,7 +1039,7 @@ public class WebMail extends HttpServlet
}
/**
* @param hashCode
- * @return
+ * @return the part or null
*/
private static MailPart getMailPartFromHashCode( MailPart part, int hashCode )
{
@@ -1171,7 +1171,7 @@ public class WebMail extends HttpServlet
}
/**
* @param httpSession
- * @return
+ * @return non-null
*/
private synchronized SessionObject getSessionObject( HttpSession httpSession )
{
@@ -1324,7 +1324,7 @@ public class WebMail extends HttpServlet
/**
* @param sessionObject
* @param response
- * @return
+ * @return success
*/
private static boolean sendAttachment(SessionObject sessionObject, HttpServletResponse response)
{
@@ -1383,7 +1383,7 @@ public class WebMail extends HttpServlet
/**
* @param sessionObject
* @param request
- * @return
+ * @return success
*/
private static boolean sendMail( SessionObject sessionObject, RequestWrapper request )
{
diff --git a/apps/susimail/src/src/i2p/susi/webmail/pop3/POP3MailBox.java b/apps/susimail/src/src/i2p/susi/webmail/pop3/POP3MailBox.java
index bbe5f8ffae..16c6ea4cf7 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/pop3/POP3MailBox.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/pop3/POP3MailBox.java
@@ -440,7 +440,7 @@ public class POP3MailBox {
/**
*
* @param cmd
- * @return
+ * @return buffer
*/
private ReadBuffer sendCmdN(String cmd )
{
@@ -448,7 +448,7 @@ public class POP3MailBox {
}
/**
* @param cmd
- * @return
+ * @return buffer
*/
private ReadBuffer sendCmdN(String cmd, int bufSize )
{
@@ -491,7 +491,7 @@ public class POP3MailBox {
*
* @param src
* @param newSize
- * @return
+ * @return new array
*/
private byte[] resizeArray( byte src[], int newSize )
{
@@ -516,8 +516,8 @@ public class POP3MailBox {
}
/**
* @param id
- * @return @throws
- * IOException
+ * @return buffer
+ * @throws IOException
*/
private ReadBuffer sendCmdNa(String cmd, int bufSize ) throws IOException
{
--
GitLab