Author: norman
Date: Thu Sep 21 02:24:49 2006
New Revision: 448501
URL: http://svn.apache.org/viewvc?view=rev&rev=448501
Log:
Fix javadocs. Thx to Robert Burrell Donkin (javadoc fixes are always welcome
;-)). See JAMES-627
Modified:
james/server/trunk/src/java/org/apache/mailet/GenericMailet.java
james/server/trunk/src/java/org/apache/mailet/GenericMatcher.java
james/server/trunk/src/java/org/apache/mailet/MailAddress.java
james/server/trunk/src/java/org/apache/mailet/MailetContext.java
james/server/trunk/src/java/org/apache/mailet/dates/SimplifiedDateFormat.java
james/server/trunk/src/java/org/apache/mailet/dates/SynchronizedDateFormat.java
Modified: james/server/trunk/src/java/org/apache/mailet/GenericMailet.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/GenericMailet.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
--- james/server/trunk/src/java/org/apache/mailet/GenericMailet.java (original)
+++ james/server/trunk/src/java/org/apache/mailet/GenericMailet.java Thu Sep 21
02:24:49 2006
@@ -147,7 +147,7 @@
* the mailet container for later use. When overriding this form of the
* method, call super.init(config).</p>
*
- * @param MailetConfig newconfig - the MailetConfig object that contains
+ * @param newConfig - the MailetConfig object that contains
* configutation information for this mailet
* @throws MessagingException
* if an exception occurs that interrupts the mailet's normal
operation
Modified: james/server/trunk/src/java/org/apache/mailet/GenericMatcher.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/GenericMatcher.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
--- james/server/trunk/src/java/org/apache/mailet/GenericMatcher.java (original)
+++ james/server/trunk/src/java/org/apache/mailet/GenericMatcher.java Thu Sep
21 02:24:49 2006
@@ -106,7 +106,7 @@
* the matcher container for alter use. When overriding this form of the
* method, call super.init(config).</p>
*
- * @param MatcherConfig config - the MatcherConfig object that contains
+ * @param newConfig - the MatcherConfig object that contains
* configutation information for this matcher
* @throws MessagingException
* if an exception occurs that interrupts the matcher's normal
operation
@@ -135,7 +135,7 @@
* Writes the specified message to a matcher log file, prepended by
* the matcher's name.
*
- * @param msg - a String specifying the message to be written to the log
file
+ * @param message - a String specifying the message to be written to the
log file
*/
public void log(String message) {
StringBuffer logBuffer =
Modified: james/server/trunk/src/java/org/apache/mailet/MailAddress.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/MailAddress.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
--- james/server/trunk/src/java/org/apache/mailet/MailAddress.java (original)
+++ james/server/trunk/src/java/org/apache/mailet/MailAddress.java Thu Sep 21
02:24:49 2006
@@ -166,8 +166,8 @@
* Construct a MailAddress with the provided personal name and email
* address.
*
- * @param user the username or account name on the mail server
- * @param host the server that should accept messages for this
user
+ * @param newUser the username or account name on the mail server
+ * @param newHost the server that should accept messages for this
user
* @throws ParseException if the parse failed
*/
public MailAddress(String newUser, String newHost) throws ParseException {
Modified: james/server/trunk/src/java/org/apache/mailet/MailetContext.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/MailetContext.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
--- james/server/trunk/src/java/org/apache/mailet/MailetContext.java (original)
+++ james/server/trunk/src/java/org/apache/mailet/MailetContext.java Thu Sep 21
02:24:49 2006
@@ -148,7 +148,7 @@
* Checks if a user account is exists in the mail context.
*
* @param userAccount - user identifier.
- * @return true if the acount is a local account
+ * @return true if the account is a local account
*
* @deprecated use isLocalEmail(MailAddress) instead
*
@@ -161,8 +161,8 @@
/**
* Checks if a user account is exists in the mail context.
*
- * @param userAccount - user identifier.
- * @return true if the acount is a local account
+ * @param mailAddress - address of the account to be checked.
+ * @return true if the account is a local account
*
* @since James 2.4.0
*/
@@ -182,7 +182,7 @@
* exception to the mailet log file.
*
* @param message - a String that describes the error or exception
- * @param throwable - the Throwable error or exception
+ * @param t - the Throwable error or exception
*/
void log(String message, Throwable t);
Modified:
james/server/trunk/src/java/org/apache/mailet/dates/SimplifiedDateFormat.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/dates/SimplifiedDateFormat.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
---
james/server/trunk/src/java/org/apache/mailet/dates/SimplifiedDateFormat.java
(original)
+++
james/server/trunk/src/java/org/apache/mailet/dates/SimplifiedDateFormat.java
Thu Sep 21 02:24:49 2006
@@ -39,7 +39,7 @@
/**
* Formats a Date into a date/time string.
- * @param date the time value to be formatted into a time string.
+ * @param d the time value to be formatted into a time string.
* @return the formatted time string.
*/
public String format(Date d);
Modified:
james/server/trunk/src/java/org/apache/mailet/dates/SynchronizedDateFormat.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/mailet/dates/SynchronizedDateFormat.java?view=diff&rev=448501&r1=448500&r2=448501
==============================================================================
---
james/server/trunk/src/java/org/apache/mailet/dates/SynchronizedDateFormat.java
(original)
+++
james/server/trunk/src/java/org/apache/mailet/dates/SynchronizedDateFormat.java
Thu Sep 21 02:24:49 2006
@@ -56,7 +56,7 @@
*
* <p>TODO: Investigate replacing this with a factory method.</p>
*
- * @param the DateFormat to synchronize
+ * @param theDateFormat the DateFormat to synchronize
*/
protected SynchronizedDateFormat(DateFormat theDateFormat) {
internalDateFormat = theDateFormat;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
