Author: ecki
Date: Sun Jan 11 15:26:28 2015
New Revision: 1650904
URL: http://svn.apache.org/r1650904
Log:
[sandbox] Remove all java8 javadoc warnings.
Modified:
commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java
Modified:
commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java
URL:
http://svn.apache.org/viewvc/commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java?rev=1650904&r1=1650903&r2=1650904&view=diff
==============================================================================
---
commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java
(original)
+++
commons/proper/vfs/trunk/sandbox/src/main/java/org/apache/commons/vfs2/provider/smb/SmbFileName.java
Sun Jan 11 15:26:28 2015
@@ -50,6 +50,7 @@ public class SmbFileName extends Generic
/**
* Returns the share name.
+ * @return share name
*/
public String getShare()
{
@@ -68,7 +69,9 @@ public class SmbFileName extends Generic
}
/**
- * put domain before username if both are set
+ * Put {@code domain} before @{code username} if both are set.
+ * <p>
+ * Uses super method to add password or password placeholder.
*/
@Override
protected void appendCredentials(final StringBuilder buffer, final boolean
addPassword)
@@ -84,6 +87,7 @@ public class SmbFileName extends Generic
/**
* Factory method for creating name instances.
+ * @return new SmbFileName object, never null.
*/
@Override
public FileName createName(final String path, final FileType type)
@@ -101,7 +105,10 @@ public class SmbFileName extends Generic
}
/**
- * Construct the path suitable for SmbFile when used with
NtlmPasswordAuthentication
+ * Construct the path suitable for SmbFile when used with
NtlmPasswordAuthentication.
+ *
+ * @return caches and return URI with no username/password, never null
+ * @throws FileSystemException if any of the invoked methods throw
*/
public String getUriWithoutAuth() throws FileSystemException
{
@@ -127,7 +134,8 @@ public class SmbFileName extends Generic
}
/**
- * returns the domain name
+ * Returns the domain name.
+ * @return domain name
*/
public String getDomain()
{
