Javadoc: Better exception description

Author: garydgregory

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java

@@ -98,6 +98,12 @@ public boolean completePendingCommand() throws IOException {
         return true;
     }
 
+    /**
+     * Creates an FTP client.
+     *
+     * @return a new FTP client.
+     * @throws FileSystemException if an error occurs while establishing a connection.
+     */
     private FTPClient createClient() throws FileSystemException {
         final GenericFileName rootName = getRoot();
         UserAuthenticationData authData = null;
@@ -111,10 +117,11 @@ private FTPClient createClient() throws FileSystemException {
 
     /**
      * Creates an FTPClient.
+     *
      * @param rootFileName the root file name.
      * @param authData authentication data.
      * @return an FTPClient.
-     * @throws FileSystemException if a file system error occurs.
+     * @throws FileSystemException if an error occurs while establishing a connection.
      */
     protected FTPClient createClient(final GenericFileName rootFileName, final UserAuthenticationData authData)
         throws FileSystemException {
@@ -162,7 +169,13 @@ public FileSystemOptions getFileSystemOptions() {
         return fileSystemOptions;
     }
 
-    private FTPClient getFtpClient() throws FileSystemException {
+    /**
+     * Package-private for debugging only, consider private.
+     *
+     * @return the actual FTP client.
+     * @throws FileSystemException if an error occurs while establishing a connection.
+     */
+    FTPClient getFtpClient() throws FileSystemException {
         if (ftpClient == null) {
             ftpClient = createClient();
         }

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpClientFactory.java

@@ -123,7 +123,7 @@ private void configureClient(final FileSystemOptions fileSystemOptions, final C
          * @param workingDirectory The working directory.
          * @param fileSystemOptions Options to create the connection.
          * @return A new connection.
-         * @throws FileSystemException if an error occurs while connecting.
+         * @throws FileSystemException if an error occurs while establishing a connection.
          */
         public C createConnection(final String hostname, final int port, char[] username, char[] password,
                 final String workingDirectory, final FileSystemOptions fileSystemOptions) throws FileSystemException {
@@ -277,7 +277,7 @@ protected void setupOpenConnection(final FTPClient client, final FileSystemOptio
      * @param workingDirectory The base directory.
      * @param fileSystemOptions The FileSystemOptions.
      * @return An FTPClient.
-     * @throws FileSystemException if an error occurs while connecting.
+     * @throws FileSystemException if an error occurs while establishing a connection.
      */
     public static FTPClient createConnection(final String hostname, final int port, final char[] username,
             final char[] password, final String workingDirectory, final FileSystemOptions fileSystemOptions)

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsClientFactory.java

@@ -84,7 +84,7 @@ protected void setupOpenConnection(final FTPSClient client, final FileSystemOpti
      * @param workingDirectory The directory to use.
      * @param fileSystemOptions The FileSystemOptions.
      * @return The FTPSClient.
-     * @throws FileSystemException if an error occurs.
+     * @throws FileSystemException if an error occurs while establishing a connection.
      */
     public static FTPSClient createConnection(final String hostname, final int port, final char[] username,
             final char[] password, final String workingDirectory, final FileSystemOptions fileSystemOptions)