Author: ggregory
Date: Sat Nov 19 16:15:23 2011
New Revision: 1204010
URL: http://svn.apache.org/viewvc?rev=1204010&view=rev
Log:
Javadoc: use the active voice when possible.
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonUserSignal.java
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java?rev=1204010&r1=1204009&r2=1204010&view=diff
==============================================================================
---
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
(original)
+++
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
Sat Nov 19 16:15:23 2011
@@ -18,7 +18,7 @@
package org.apache.commons.daemon;
/**
- * This interface provides support for native daemon invocation. Using
+ * Provides support for native daemon invocation. Using
* a platform dependant helper program, classes that implement the
* <code>Daemon</code> interface can be initialized, started and
* stopped according to the conventions of the underlying operating
@@ -35,7 +35,7 @@ public interface Daemon
{
/**
- * Initialize this <code>Daemon</code> instance.
+ * Initializes this <code>Daemon</code> instance.
* <p>
* This method gets called once the JVM process is created and the
* <code>Daemon</code> instance is created thru its empty public
@@ -73,7 +73,7 @@ public interface Daemon
throws DaemonInitException, Exception;
/**
- * Start the operation of this <code>Daemon</code> instance. This
+ * Starts the operation of this <code>Daemon</code> instance. This
* method is to be invoked by the environment after the init()
* method has been successfully invoked and possibly the security
* level of the JVM has been dropped. Implementors of this
@@ -85,7 +85,7 @@ public interface Daemon
throws Exception;
/**
- * Stop the operation of this <code>Daemon</code> instance. Note
+ * Stops the operation of this <code>Daemon</code> instance. Note
* that the proper place to free any allocated resources such as
* sockets or file descriptors is in the destroy method, as the
* container may restart the Daemon by calling start() after
@@ -95,7 +95,7 @@ public interface Daemon
throws Exception;
/**
- * Free any resources allocated by this daemon such as file
+ * Frees any resources allocated by this daemon such as file
* descriptors or sockets. This method gets called by the container
* after stop() has been called, before the JVM exits. The Daemon
* can not be restarted after this method has been called without a
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java?rev=1204010&r1=1204009&r2=1204010&view=diff
==============================================================================
---
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
(original)
+++
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
Sat Nov 19 16:15:23 2011
@@ -19,7 +19,7 @@ package org.apache.commons.daemon;
/**
- * Interface which defines methods needed by the DaemonLoader.
+ * Defines methods needed by the DaemonLoader.
*
* @author Pier Fumagalli
* @version $Id$
@@ -28,37 +28,37 @@ public interface DaemonController
{
/**
- * Shutdown the daemon.
+ * Shuts down the daemon.
*/
public void shutdown()
throws IllegalStateException;
/**
- * Reload daemon
+ * Reloads daemon
*/
public void reload()
throws IllegalStateException;
/**
- * Shudown daemon and log failed message.
+ * Shuts down daemon and logs failed message.
*/
public void fail()
throws IllegalStateException;
/**
- * Shudown daemon and log failed message.
+ * Shuts down daemon and logs failed message.
*/
public void fail(String message)
throws IllegalStateException;
/**
- * Shudown daemon and log failed message.
+ * Shuts down daemon and logs failed message.
*/
public void fail(Exception exception)
throws IllegalStateException;
/**
- * Shudown daemon and log failed message.
+ * Shuts down daemon and logs failed message.
*/
public void fail(String message, Exception exception)
throws IllegalStateException;
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java?rev=1204010&r1=1204009&r2=1204010&view=diff
==============================================================================
---
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
(original)
+++
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
Sat Nov 19 16:15:23 2011
@@ -21,7 +21,7 @@ import java.security.Permission;
import java.util.StringTokenizer;
/**
- * This class represents the permissions to control and query the status of
+ * Represents the permissions to control and query the status of
* a <code>Daemon</code>. A <code>DaemonPermission</code> consists of a
* target name and a list of actions associated with it.
* <p>
@@ -173,7 +173,7 @@ public final class DaemonPermission exte
*/
/**
- * Create a new <code>DaemonPermission</code> instance with a specified
+ * Creates a new <code>DaemonPermission</code> instance with a specified
* permission name.
* <p>
* This constructor will create a new <code>DaemonPermission</code>
@@ -205,7 +205,7 @@ public final class DaemonPermission exte
}
/**
- * Create a new <code>DaemonPermission</code> instance with a specified
+ * Creates a new <code>DaemonPermission</code> instance with a specified
* permission name and a specified list of actions.
* <p>
* </p>
@@ -234,7 +234,7 @@ public final class DaemonPermission exte
*/
/**
- * Return the list of actions permitted by this instance of
+ * Returns the list of actions permitted by this instance of
* <code>DaemonPermission</code> in its canonical form.
*
* @return The canonicalized list of actions.
@@ -248,7 +248,7 @@ public final class DaemonPermission exte
}
/**
- * Return the hash code for this <code>DaemonPermission</code> instance.
+ * Returns the hash code for this <code>DaemonPermission</code> instance.
*
* @return An hash code value.
*/
@@ -259,7 +259,7 @@ public final class DaemonPermission exte
}
/**
- * Check if a specified object equals <code>DaemonPermission</code>.
+ * Checks if a specified object equals <code>DaemonPermission</code>.
*
* @return <b>true</b> or <b>false</b> wether the specified object equals
* this <code>DaemonPermission</code> instance or not.
@@ -280,7 +280,7 @@ public final class DaemonPermission exte
}
/**
- * Check if this <code>DaemonPermission</code> implies another
+ * Checks if this <code>DaemonPermission</code> implies another
* <code>Permission</code>.
*
* @return <b>true</b> or <b>false</b> wether the specified permission
@@ -303,7 +303,7 @@ public final class DaemonPermission exte
}
/**
- * Return a <code>String</code> representation of this instance.
+ * Returns a <code>String</code> representation of this instance.
*
* @return A <code>String</code> representing this
* <code>DaemonPermission</code> instance.
@@ -318,7 +318,8 @@ public final class DaemonPermission exte
* Private methods
*/
- /** Create a String description for this permission instance.
+ /**
+ * Creates a String description for this permission instance.
*/
private void setupDescription()
{
@@ -343,7 +344,8 @@ public final class DaemonPermission exte
this.desc = buf.toString();
}
- /** Create a permission mask for a given control actions string.
+ /**
+ * Creates a permission mask for a given control actions string.
*/
private int createControlMask(String actions)
throws IllegalArgumentException
@@ -381,7 +383,7 @@ public final class DaemonPermission exte
return mask;
}
- /** Create a actions list for a given control permission mask. */
+ /** Creates a actions list for a given control permission mask. */
private String createControlActions(int mask)
{
StringBuffer buf = new StringBuffer();
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonUserSignal.java
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonUserSignal.java?rev=1204010&r1=1204009&r2=1204010&view=diff
==============================================================================
---
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonUserSignal.java
(original)
+++
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonUserSignal.java
Sat Nov 19 16:15:23 2011
@@ -18,7 +18,7 @@
package org.apache.commons.daemon;
/**
- * This interface tags a Daemon as supporting some kind of
+ * Tags a Daemon as supporting some kind of
* signaling method that allows the java application to
* perform a custom action.
* <p>
@@ -33,7 +33,7 @@ public interface DaemonUserSignal
{
/**
- * Perform a custom action on received user signal.
+ * Performs a custom action on received user signal.
*/
void signal();
Modified:
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java?rev=1204010&r1=1204009&r2=1204010&view=diff
==============================================================================
---
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
(original)
+++
commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
Sat Nov 19 16:15:23 2011
@@ -75,7 +75,7 @@ public final class DaemonConfiguration
}
/**
- * Load the configuration properties file.
+ * Loads the configuration properties file.
*
* @param fileName The properties file to load.
* @return <code>true</code> if the file was loaded.
@@ -155,7 +155,8 @@ public final class DaemonConfiguration
}
/**
- * Get the configuration property.
+ * Gets the configuration property.
+ *
* @param name The name of the property to get.
*
* @throws ParseException if the property is wrongly formatted.
@@ -170,7 +171,7 @@ public final class DaemonConfiguration
}
/**
- * Get the configuration property array.
+ * Gets the configuration property array.
* <p>
* Property array is constructed form the lsit of properties
* which end with <code>[index]</code>
