Author: ggregory Date: Thu May 17 14:42:36 2012 New Revision: 1339620 URL: http://svn.apache.org/viewvc?rev=1339620&view=rev Log: Use the active voice in Javadocs and fix typos.
Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java?rev=1339620&r1=1339619&r2=1339620&view=diff ============================================================================== --- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java (original) +++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/UserAuthenticatorUtils.java Thu May 17 14:42:36 2012 @@ -22,7 +22,7 @@ import org.apache.commons.vfs2.UserAuthe import org.apache.commons.vfs2.impl.DefaultFileSystemConfigBuilder; /** - * Some helper methods used for authentication. + * Helps with authentication. */ public final class UserAuthenticatorUtils { @@ -31,8 +31,9 @@ public final class UserAuthenticatorUtil } /** - * gets data of given type from the UserAuthenticationData or null if there is no data or data + * Gets data of given type from the UserAuthenticationData or null if there is no data or data * of this type available. + * * @param data The UserAuthenticationData. * @param type The type of the element to retrieve. * @param overriddenValue The default value. @@ -55,7 +56,8 @@ public final class UserAuthenticatorUtil } /** - * if there is a authenticator the authentication will take place, else null will be returned. + * Authenticates if there is an authenticator, else returns null. + * * @param opts The FileSystemOptions. * @param authenticatorTypes An array of types describing the data to be retrieved. * @return A UserAuthenticationData object containing the data requested. @@ -68,7 +70,8 @@ public final class UserAuthenticatorUtil } /** - * if there is a authenticator the authentication will take place, else null will be returned. + * Authenticates if there is an authenticator, else returns null. + * * @param auth The UserAuthenticator. * @param authenticatorTypes An array of types describing the data to be retrieved. * @return A UserAuthenticationData object containing the data requested. @@ -85,7 +88,8 @@ public final class UserAuthenticatorUtil } /** - * Converts a string to a char array (null safe). + * Converts a string to a char array (null-safe). + * * @param string The String to convert. * @return The character array. */ @@ -100,7 +104,8 @@ public final class UserAuthenticatorUtil } /** - * cleanup the data in the UerAuthenticationData (null safe). + * Cleans up the data in the UerAuthenticationData (null-safe). + * * @param authData The UserAuthenticationDAta. */ public static void cleanup(UserAuthenticationData authData) @@ -114,7 +119,8 @@ public final class UserAuthenticatorUtil } /** - * converts the given data to a string (null safe). + * Converts the given data to a string (null-safe). + * * @param data A character array containing the data to convert to a String. * @return The String. */