Author: rdonkin
Date: Tue Sep 15 13:35:38 2009
New Revision: 815325
URL: http://svn.apache.org/viewvc?rev=815325&view=rev
Log:
Improve javadocs
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/ConnectHandler.java
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/JamesConfiguration.java
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/LineHandler.java
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/WiringException.java
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/core/filter/fastfail/SpamAssassinHandler.java
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/ConnectHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/ConnectHandler.java?rev=815325&r1=815324&r2=815325&view=diff
==============================================================================
---
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/ConnectHandler.java
(original)
+++
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/ConnectHandler.java
Tue Sep 15 13:35:38 2009
@@ -29,9 +29,10 @@
* in the SMTPSession object
*/
public interface ConnectHandler {
- /*
- * Handle connection
- **/
+ /**
+ * Handle connection.
+ * @param session not null
+ */
void onConnect(SMTPSession session);
}
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/JamesConfiguration.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/JamesConfiguration.java?rev=815325&r1=815324&r2=815325&view=diff
==============================================================================
---
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/JamesConfiguration.java
(original)
+++
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/JamesConfiguration.java
Tue Sep 15 13:35:38 2009
@@ -27,14 +27,10 @@
import org.apache.commons.configuration.tree.xpath.XPathExpressionEngine;
/**
- *
+ * Bridges commons configuration to Avalon.
*/
public class JamesConfiguration extends XMLConfiguration {
-
- /**
- *
- */
private static final long serialVersionUID = 6920719067623856243L;
public
JamesConfiguration(org.apache.avalon.framework.configuration.Configuration
avalonConfig) throws ConfigurationException {
@@ -42,6 +38,5 @@
load(new ByteArrayInputStream(config.getBytes()));
setExpressionEngine(new XPathExpressionEngine());
-
}
}
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/LineHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/LineHandler.java?rev=815325&r1=815324&r2=815325&view=diff
==============================================================================
---
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/LineHandler.java
(original)
+++
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/LineHandler.java
Tue Sep 15 13:35:38 2009
@@ -25,8 +25,10 @@
public interface LineHandler {
/**
- * Handle the command
- **/
+ * Handle the command.
+ * @param session not null
+ * @param line not null
+ */
void onLine(SMTPSession session, byte[] line);
}
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/WiringException.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/WiringException.java?rev=815325&r1=815324&r2=815325&view=diff
==============================================================================
---
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/WiringException.java
(original)
+++
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/WiringException.java
Tue Sep 15 13:35:38 2009
@@ -18,11 +18,12 @@
****************************************************************/
package org.apache.james.smtpserver;
+/**
+ * Indicates an issue prevent the successful wiring of the components
+ * composing the SMTP processor.
+ */
public class WiringException extends Exception {
- /**
- *
- */
private static final long serialVersionUID = 8824880646965171467L;
/**
Modified:
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/core/filter/fastfail/SpamAssassinHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/core/filter/fastfail/SpamAssassinHandler.java?rev=815325&r1=815324&r2=815325&view=diff
==============================================================================
---
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/core/filter/fastfail/SpamAssassinHandler.java
(original)
+++
james/server/trunk/smtpserver-function/src/main/java/org/apache/james/smtpserver/core/filter/fastfail/SpamAssassinHandler.java
Tue Sep 15 13:35:38 2009
@@ -72,7 +72,6 @@
private boolean checkAuthNetworks = false;
/**
- * (non-Javadoc)
* @see
org.apache.james.smtpserver.Configurable#configure(org.apache.commons.configuration.Configuration)
*/
public void configure(Configuration config) throws ConfigurationException {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
