You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2013/08/13 15:41:38 UTC
svn commit: r1513482 -
/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Author: ggregory
Date: Tue Aug 13 13:41:38 2013
New Revision: 1513482
URL: http://svn.apache.org/r1513482
Log:
Better Javadoc.
Modified:
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/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=1513482&r1=1513481&r2=1513482&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 13:41:38 2013
@@ -371,9 +371,11 @@ public final class SftpFileSystemConfigB
}
/**
+ * Returns <code>true</code> if the user directory is the root directory. Defaults to <code>true</code>.
+ *
* @param opts
* The FileSystemOptions.
- * @return true if the user directory is the root.
+ * @return <code>true</code> if the user directory is the root; defaults to <code>true</code>.
* @see #setUserDirIsRoot
*/
public Boolean getUserDirIsRoot(final FileSystemOptions opts)
Re: svn commit: r1513482 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Posted by sebb <se...@gmail.com>.
On 13 August 2013 15:28, Gary Gregory <ga...@gmail.com> wrote:
> On Tue, Aug 13, 2013 at 10:02 AM, sebb <se...@gmail.com> wrote:
>
>> On 13 August 2013 14:41, <gg...@apache.org> wrote:
>> > Author: ggregory
>> > Date: Tue Aug 13 13:41:38 2013
>> > New Revision: 1513482
>> >
>> > URL: http://svn.apache.org/r1513482
>> > Log:
>> > Better Javadoc.
>> >
>> > Modified:
>> >
>> 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/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=1513482&r1=1513481&r2=1513482&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 13:41:38 2013
>> > @@ -371,9 +371,11 @@ public final class SftpFileSystemConfigB
>> > }
>> >
>> > /**
>> > + * Returns <code>true</code> if the user directory is the root
>> directory. Defaults to <code>true</code>.
>>
>> What does default mean in this case?
>> Under what circumstances is the default applicable?
>>
>
> Committed again:
>
> /**
> * Returns <code>true</code> if VFS treats the user directory as the
> root directory. Defaults to <code>true</code>.
> *
> * @param opts
> * The FileSystemOptions.
> * @return <code>true</code> if VFS treats the user directory as the
> root directory. Defaults to <code>true</code>.
> * @see #setUserDirIsRoot
> */
>
> Better?
Sorry, no; see reply in other thread.
> Gary
>
>>
>> > + *
>> > * @param opts
>> > * The FileSystemOptions.
>> > - * @return true if the user directory is the root.
>> > + * @return <code>true</code> if the user directory is the root;
>> defaults to <code>true</code>.
>> > * @see #setUserDirIsRoot
>> > */
>> > public Boolean getUserDirIsRoot(final FileSystemOptions opts)
>> >
>> >
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>
>
> --
> E-Mail: garydgregory@gmail.com | ggregory@apache.org
> Java Persistence with Hibernate, Second Edition<http://www.manning.com/bauer3/>
> JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
> Spring Batch in Action <http://www.manning.com/templier/>
> Blog: http://garygregory.wordpress.com
> Home: http://garygregory.com/
> Tweet! http://twitter.com/GaryGregory
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r1513482 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Posted by Gary Gregory <ga...@gmail.com>.
On Tue, Aug 13, 2013 at 10:02 AM, sebb <se...@gmail.com> wrote:
> On 13 August 2013 14:41, <gg...@apache.org> wrote:
> > Author: ggregory
> > Date: Tue Aug 13 13:41:38 2013
> > New Revision: 1513482
> >
> > URL: http://svn.apache.org/r1513482
> > Log:
> > Better Javadoc.
> >
> > Modified:
> >
> 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/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=1513482&r1=1513481&r2=1513482&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 13:41:38 2013
> > @@ -371,9 +371,11 @@ public final class SftpFileSystemConfigB
> > }
> >
> > /**
> > + * Returns <code>true</code> if the user directory is the root
> directory. Defaults to <code>true</code>.
>
> What does default mean in this case?
> Under what circumstances is the default applicable?
>
Committed again:
/**
* Returns <code>true</code> if VFS treats the user directory as the
root directory. Defaults to <code>true</code>.
*
* @param opts
* The FileSystemOptions.
* @return <code>true</code> if VFS treats the user directory as the
root directory. Defaults to <code>true</code>.
* @see #setUserDirIsRoot
*/
Better?
Gary
>
> > + *
> > * @param opts
> > * The FileSystemOptions.
> > - * @return true if the user directory is the root.
> > + * @return <code>true</code> if the user directory is the root;
> defaults to <code>true</code>.
> > * @see #setUserDirIsRoot
> > */
> > public Boolean getUserDirIsRoot(final FileSystemOptions opts)
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
--
E-Mail: garydgregory@gmail.com | ggregory@apache.org
Java Persistence with Hibernate, Second Edition<http://www.manning.com/bauer3/>
JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
Spring Batch in Action <http://www.manning.com/templier/>
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory
Re: svn commit: r1513482 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemConfigBuilder.java
Posted by sebb <se...@gmail.com>.
On 13 August 2013 14:41, <gg...@apache.org> wrote:
> Author: ggregory
> Date: Tue Aug 13 13:41:38 2013
> New Revision: 1513482
>
> URL: http://svn.apache.org/r1513482
> Log:
> Better Javadoc.
>
> Modified:
> 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/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=1513482&r1=1513481&r2=1513482&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 13:41:38 2013
> @@ -371,9 +371,11 @@ public final class SftpFileSystemConfigB
> }
>
> /**
> + * Returns <code>true</code> if the user directory is the root directory. Defaults to <code>true</code>.
What does default mean in this case?
Under what circumstances is the default applicable?
> + *
> * @param opts
> * The FileSystemOptions.
> - * @return true if the user directory is the root.
> + * @return <code>true</code> if the user directory is the root; defaults to <code>true</code>.
> * @see #setUserDirIsRoot
> */
> public Boolean getUserDirIsRoot(final FileSystemOptions opts)
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org