Author: ggregory
Date: Tue Aug 13 15:01:42 2013
New Revision: 1513532
URL: http://svn.apache.org/r1513532
Log:
Better Javadoc.
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java?rev=1513532&r1=1513531&r2=1513532&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileSystemConfigBuilder.java
Tue Aug 13 15:01:42 2013
@@ -209,11 +209,13 @@ public class FtpFileSystemConfigBuilder
}
/**
- * Returns <code>true</code> if VFS treats the user directory as the root
directory. Defaults to <code>true</code>.
+ * Returns {@link Boolean#TRUE} if VFS should treat the user directory as
the root directory. Defaults to
+ * <code>Boolean.TRUE</code> if the method {@link
#setUserDirIsRoot(FileSystemOptions, boolean)} has not been
+ * invoked.
*
* @param opts
* The FileSystemOptions.
- * @return <code>true</code> if VFS treats the user directory as the root
directory. Defaults to <code>true</code>.
+ * @return <code>Boolean.TRUE</code> if VFS treats the user directory as
the root directory.
* @see #setUserDirIsRoot
*/
public Boolean getUserDirIsRoot(final FileSystemOptions opts)
Modified:
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java?rev=1513532&r1=1513531&r2=1513532&view=diff
==============================================================================
---
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
(original)
+++
commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Tue Aug 13 15:01:42 2013
@@ -371,11 +371,13 @@ public final class SftpFileSystemConfigB
}
/**
- * Returns <code>true</code> if VFS treats the user directory as the root
directory. Defaults to <code>true</code>.
+ * Returns {@link Boolean#TRUE} if VFS should treat the user directory as
the root directory. Defaults to
+ * <code>Boolean.TRUE</code> if the method {@link
#setUserDirIsRoot(FileSystemOptions, boolean)} has not been
+ * invoked.
*
* @param opts
* The FileSystemOptions.
- * @return <code>true</code> if VFS treats the user directory as the root
directory. Defaults to <code>true</code>.
+ * @return <code>Boolean.TRUE</code> if VFS treats the user directory as
the root directory.
* @see #setUserDirIsRoot
*/
public Boolean getUserDirIsRoot(final FileSystemOptions opts)
