From e8abe14395e63e6c9745cf33ef9b5a5eca671ce1 Mon Sep 17 00:00:00 2001
From: mathiasdm <mathiasdm@mail.i2p>
Date: Wed, 20 Oct 2010 15:55:28 +0000
Subject: [PATCH] Fixed susimail javadoc errors.
---
.../src/src/i2p/susi/util/Config.java | 3 --
.../src/src/i2p/susi/util/Folder.java | 16 +++-----
.../src/src/i2p/susi/webmail/Attachment.java | 12 ++----
.../src/src/i2p/susi/webmail/Mail.java | 5 +--
.../src/src/i2p/susi/webmail/MailCache.java | 4 +-
.../src/i2p/susi/webmail/RequestWrapper.java | 39 ++++---------------
6 files changed, 20 insertions(+), 59 deletions(-)
diff --git a/apps/susimail/src/src/i2p/susi/util/Config.java b/apps/susimail/src/src/i2p/susi/util/Config.java
index 723c56b992..8564cbfad8 100644
--- a/apps/susimail/src/src/i2p/susi/util/Config.java
+++ b/apps/susimail/src/src/i2p/susi/util/Config.java
@@ -42,7 +42,6 @@ public class Config {
/**
*
* @param name
- * @return
*/
public static String getProperty( String name )
{
@@ -98,7 +97,6 @@ public class Config {
*
* @param name
* @param defaultValue
- * @return
*/
public static String getProperty( String name, String defaultValue )
{
@@ -109,7 +107,6 @@ public class Config {
*
* @param name
* @param defaultValue
- * @return
*/
public static int getProperty( String name, int defaultValue )
{
diff --git a/apps/susimail/src/src/i2p/susi/util/Folder.java b/apps/susimail/src/src/i2p/susi/util/Folder.java
index 7a18a2477d..c8cd9b7669 100644
--- a/apps/susimail/src/src/i2p/susi/util/Folder.java
+++ b/apps/susimail/src/src/i2p/susi/util/Folder.java
@@ -270,7 +270,7 @@ public class Folder {
/**
* Returns the element on the current page on the given position.
*
- * @param Position of the element on the current page.
+ * @param x Position of the element on the current page.
* @return Element on the current page on the given position.
*/
public Object getElementAtPosXonCurrentPage( int x )
@@ -331,7 +331,7 @@ public class Folder {
* Gets index of an element in the array regardless of sorting direction.
*
* @param element
- * @return
+ * @return index
*/
private int getIndexOf( Object element )
{
@@ -348,7 +348,7 @@ public class Folder {
* Sorting direction is taken into account.
*
* @param element
- * @return
+ * @return The next element
*/
public Object getNextElement( Object element )
{
@@ -369,7 +369,7 @@ public class Folder {
* Sorting direction is taken into account.
*
* @param element
- * @return
+ * @return The previous element
*/
public Object getPreviousElement( Object element )
{
@@ -388,7 +388,7 @@ public class Folder {
* Retrieves element at index i. Depends on sorting direction.
*
* @param i
- * @return
+ * @return Element at index i
*/
private Object getElement( int i )
{
@@ -404,8 +404,6 @@ public class Folder {
/**
* Returns true, if folder shows points to the last page.
- *
- * @return
*/
public boolean isLastPage()
{
@@ -414,8 +412,6 @@ public class Folder {
/**
* Returns true, if folder shows points to the first page.
- *
- * @return
*/
public boolean isFirstPage()
{
@@ -427,7 +423,6 @@ public class Folder {
* The sorting direction influences which element is taken for comparison.
*
* @param element
- * @return
*/
public boolean isLastElement( Object element )
{
@@ -441,7 +436,6 @@ public class Folder {
* The sorting direction influences which element is taken for comparison.
*
* @param element
- * @return
*/
public boolean isFirstElement( Object element )
{
diff --git a/apps/susimail/src/src/i2p/susi/webmail/Attachment.java b/apps/susimail/src/src/i2p/susi/webmail/Attachment.java
index 91da870640..922ca8069f 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/Attachment.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/Attachment.java
@@ -56,16 +56,12 @@ public class Attachment {
public void setBuffer(ReadBuffer buffer) {
this.buffer = buffer;
}
- /**
- * @return
- */
+
public String getTransferEncoding() {
// TODO Auto-generated method stub
return transferEncoding;
}
- /**
- * @return
- */
+
public String getContentType() {
// TODO Auto-generated method stub
return contentType;
@@ -82,9 +78,7 @@ public class Attachment {
public void setTransferEncoding(String transferEncoding) {
this.transferEncoding = transferEncoding;
}
- /**
- * @param string
- */
+
public void setData(String data ) {
this.data = data;
}
diff --git a/apps/susimail/src/src/i2p/susi/webmail/Mail.java b/apps/susimail/src/src/i2p/susi/webmail/Mail.java
index 80f6d67bff..98cf7c9e59 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/Mail.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/Mail.java
@@ -78,8 +78,8 @@ public class Mail {
}
/**
*
- * @param address
- * @return
+ * @param address E-mail address to be validated
+ * @return Is the e-mail address valid?
*/
public static boolean validateAddress( String address )
{
@@ -105,7 +105,6 @@ public class Mail {
}
/**
* @param address
- * @return
*/
public static String getAddress(String address )
{
diff --git a/apps/susimail/src/src/i2p/susi/webmail/MailCache.java b/apps/susimail/src/src/i2p/susi/webmail/MailCache.java
index 05694f2bf5..a7116811ce 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/MailCache.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/MailCache.java
@@ -47,9 +47,9 @@ public class MailCache {
/**
* Fetch any needed data from pop3 server.
*
- * @param id message id to get
+ * @param uidl message id to get
* @param headerOnly fetch only header lines?
- * @return
+ * @return An e-mail
*/
public Mail getMail( String uidl, boolean headerOnly ) {
diff --git a/apps/susimail/src/src/i2p/susi/webmail/RequestWrapper.java b/apps/susimail/src/src/i2p/susi/webmail/RequestWrapper.java
index 0cb20af2f6..0c1d835cc1 100644
--- a/apps/susimail/src/src/i2p/susi/webmail/RequestWrapper.java
+++ b/apps/susimail/src/src/i2p/susi/webmail/RequestWrapper.java
@@ -67,29 +67,25 @@ public class RequestWrapper {
/**
* @param b
- * @return
*/
public HttpSession getSession(boolean b) {
return httpRequest.getSession( b );
}
/**
- * @param key
- * @return
+ * @param name Specific parameter key
+ * @return parameter value
*/
public String getParameter(String name ) {
return getParameter( name, null );
}
- /**
- * @return
- */
public HttpSession getSession() {
return httpRequest.getSession();
}
/**
- * @return
+ * @return List of request parameter names
*/
public Enumeration getParameterNames() {
if( multiPartRequest != null ) {
@@ -106,24 +102,19 @@ public class RequestWrapper {
}
/**
- * @return
+ * @return The total length of the content.
*/
public int getContentLength() {
return httpRequest.getContentLength();
}
/**
- * @return
+ * @return The content type of the request.
*/
public String getContentType() {
return httpRequest.getContentType();
}
- /**
- *
- * @param partName
- * @return
- */
public String getContentType( String partName )
{
String result = null;
@@ -143,19 +134,11 @@ public class RequestWrapper {
}
return result;
}
- /**
- * @param string
- * @return
- */
+
public Object getAttribute(String string) {
return httpRequest.getAttribute( string );
}
- /**
- * @param new_subject
- * @param string
- * @return
- */
public String getParameter( String name, String defaultValue )
{
String result = defaultValue;
@@ -184,10 +167,7 @@ public class RequestWrapper {
}
return result;
}
- /**
- * @param new_filename
- * @return
- */
+
public String getFilename(String partName )
{
String result = null;
@@ -198,10 +178,7 @@ public class RequestWrapper {
}
return result;
}
- /**
- * @param new_filename
- * @return
- */
+
public InputStream getInputStream(String partName )
{
InputStream result = null;
--
GitLab