Fixed susimail javadoc errors.

This commit is contained in:
mathiasdm
2010-10-20 15:55:28 +00:00
parent 3daa6b964d
commit e8abe14395
6 changed files with 20 additions and 59 deletions

View File

@ -42,7 +42,6 @@ public class Config {
/** /**
* *
* @param name * @param name
* @return
*/ */
public static String getProperty( String name ) public static String getProperty( String name )
{ {
@ -98,7 +97,6 @@ public class Config {
* *
* @param name * @param name
* @param defaultValue * @param defaultValue
* @return
*/ */
public static String getProperty( String name, String defaultValue ) public static String getProperty( String name, String defaultValue )
{ {
@ -109,7 +107,6 @@ public class Config {
* *
* @param name * @param name
* @param defaultValue * @param defaultValue
* @return
*/ */
public static int getProperty( String name, int defaultValue ) public static int getProperty( String name, int defaultValue )
{ {

View File

@ -270,7 +270,7 @@ public class Folder {
/** /**
* Returns the element on the current page on the given position. * 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. * @return Element on the current page on the given position.
*/ */
public Object getElementAtPosXonCurrentPage( int x ) public Object getElementAtPosXonCurrentPage( int x )
@ -331,7 +331,7 @@ public class Folder {
* Gets index of an element in the array regardless of sorting direction. * Gets index of an element in the array regardless of sorting direction.
* *
* @param element * @param element
* @return * @return index
*/ */
private int getIndexOf( Object element ) private int getIndexOf( Object element )
{ {
@ -348,7 +348,7 @@ public class Folder {
* Sorting direction is taken into account. * Sorting direction is taken into account.
* *
* @param element * @param element
* @return * @return The next element
*/ */
public Object getNextElement( Object element ) public Object getNextElement( Object element )
{ {
@ -369,7 +369,7 @@ public class Folder {
* Sorting direction is taken into account. * Sorting direction is taken into account.
* *
* @param element * @param element
* @return * @return The previous element
*/ */
public Object getPreviousElement( Object element ) public Object getPreviousElement( Object element )
{ {
@ -388,7 +388,7 @@ public class Folder {
* Retrieves element at index i. Depends on sorting direction. * Retrieves element at index i. Depends on sorting direction.
* *
* @param i * @param i
* @return * @return Element at index i
*/ */
private Object getElement( int i ) private Object getElement( int i )
{ {
@ -404,8 +404,6 @@ public class Folder {
/** /**
* Returns true, if folder shows points to the last page. * Returns true, if folder shows points to the last page.
*
* @return
*/ */
public boolean isLastPage() public boolean isLastPage()
{ {
@ -414,8 +412,6 @@ public class Folder {
/** /**
* Returns true, if folder shows points to the first page. * Returns true, if folder shows points to the first page.
*
* @return
*/ */
public boolean isFirstPage() public boolean isFirstPage()
{ {
@ -427,7 +423,6 @@ public class Folder {
* The sorting direction influences which element is taken for comparison. * The sorting direction influences which element is taken for comparison.
* *
* @param element * @param element
* @return
*/ */
public boolean isLastElement( Object element ) public boolean isLastElement( Object element )
{ {
@ -441,7 +436,6 @@ public class Folder {
* The sorting direction influences which element is taken for comparison. * The sorting direction influences which element is taken for comparison.
* *
* @param element * @param element
* @return
*/ */
public boolean isFirstElement( Object element ) public boolean isFirstElement( Object element )
{ {

View File

@ -56,16 +56,12 @@ public class Attachment {
public void setBuffer(ReadBuffer buffer) { public void setBuffer(ReadBuffer buffer) {
this.buffer = buffer; this.buffer = buffer;
} }
/**
* @return
*/
public String getTransferEncoding() { public String getTransferEncoding() {
// TODO Auto-generated method stub // TODO Auto-generated method stub
return transferEncoding; return transferEncoding;
} }
/**
* @return
*/
public String getContentType() { public String getContentType() {
// TODO Auto-generated method stub // TODO Auto-generated method stub
return contentType; return contentType;
@ -82,9 +78,7 @@ public class Attachment {
public void setTransferEncoding(String transferEncoding) { public void setTransferEncoding(String transferEncoding) {
this.transferEncoding = transferEncoding; this.transferEncoding = transferEncoding;
} }
/**
* @param string
*/
public void setData(String data ) { public void setData(String data ) {
this.data = data; this.data = data;
} }

View File

@ -78,8 +78,8 @@ public class Mail {
} }
/** /**
* *
* @param address * @param address E-mail address to be validated
* @return * @return Is the e-mail address valid?
*/ */
public static boolean validateAddress( String address ) public static boolean validateAddress( String address )
{ {
@ -105,7 +105,6 @@ public class Mail {
} }
/** /**
* @param address * @param address
* @return
*/ */
public static String getAddress(String address ) public static String getAddress(String address )
{ {

View File

@ -47,9 +47,9 @@ public class MailCache {
/** /**
* Fetch any needed data from pop3 server. * 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? * @param headerOnly fetch only header lines?
* @return * @return An e-mail
*/ */
public Mail getMail( String uidl, boolean headerOnly ) { public Mail getMail( String uidl, boolean headerOnly ) {

View File

@ -67,29 +67,25 @@ public class RequestWrapper {
/** /**
* @param b * @param b
* @return
*/ */
public HttpSession getSession(boolean b) { public HttpSession getSession(boolean b) {
return httpRequest.getSession( b ); return httpRequest.getSession( b );
} }
/** /**
* @param key * @param name Specific parameter key
* @return * @return parameter value
*/ */
public String getParameter(String name ) { public String getParameter(String name ) {
return getParameter( name, null ); return getParameter( name, null );
} }
/**
* @return
*/
public HttpSession getSession() { public HttpSession getSession() {
return httpRequest.getSession(); return httpRequest.getSession();
} }
/** /**
* @return * @return List of request parameter names
*/ */
public Enumeration getParameterNames() { public Enumeration getParameterNames() {
if( multiPartRequest != null ) { if( multiPartRequest != null ) {
@ -106,24 +102,19 @@ public class RequestWrapper {
} }
/** /**
* @return * @return The total length of the content.
*/ */
public int getContentLength() { public int getContentLength() {
return httpRequest.getContentLength(); return httpRequest.getContentLength();
} }
/** /**
* @return * @return The content type of the request.
*/ */
public String getContentType() { public String getContentType() {
return httpRequest.getContentType(); return httpRequest.getContentType();
} }
/**
*
* @param partName
* @return
*/
public String getContentType( String partName ) public String getContentType( String partName )
{ {
String result = null; String result = null;
@ -143,19 +134,11 @@ public class RequestWrapper {
} }
return result; return result;
} }
/**
* @param string
* @return
*/
public Object getAttribute(String string) { public Object getAttribute(String string) {
return httpRequest.getAttribute( string ); return httpRequest.getAttribute( string );
} }
/**
* @param new_subject
* @param string
* @return
*/
public String getParameter( String name, String defaultValue ) public String getParameter( String name, String defaultValue )
{ {
String result = defaultValue; String result = defaultValue;
@ -184,10 +167,7 @@ public class RequestWrapper {
} }
return result; return result;
} }
/**
* @param new_filename
* @return
*/
public String getFilename(String partName ) public String getFilename(String partName )
{ {
String result = null; String result = null;
@ -198,10 +178,7 @@ public class RequestWrapper {
} }
return result; return result;
} }
/**
* @param new_filename
* @return
*/
public InputStream getInputStream(String partName ) public InputStream getInputStream(String partName )
{ {
InputStream result = null; InputStream result = null;