commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1362066 - in /commons/proper/vfs/trunk/core/src: main/java/org/apache/commons/vfs2/ main/java/org/apache/commons/vfs2/operations/ main/java/org/apache/commons/vfs2/provider/ main/java/org/apache/commons/vfs2/provider/compressed/ main/java/...
Date Mon, 16 Jul 2012 14:40:49 GMT
Author: ggregory
Date: Mon Jul 16 14:40:49 2012
New Revision: 1362066

URL: http://svn.apache.org/viewvc?rev=1362066&view=rev
Log:
Use Javadoc {@code ...} instead of HTML <code>...</code>

Modified:
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
    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/ftps/FtpsFileSystemConfigBuilder.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
    commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileContent.java Mon
Jul 16 14:40:49 2012
@@ -28,10 +28,10 @@ import org.apache.commons.vfs2.util.Rand
 /**
  * Represents the data content of a file.
  * <p>
- * To read from a file, use the <code>InputStream</code> returned by {@link #getInputStream()}.
+ * To read from a file, use the {@code InputStream} returned by {@link #getInputStream()}.
  * </p>
  * <p>
- * To write to a file, use the <code>OutputStream</code> returned by {@link #getOutputStream()}
method. This will create
+ * To write to a file, use the {@code OutputStream} returned by {@link #getOutputStream()}
method. This will create
  * the file, and the parent folder, if necessary.
  * </p>
  * <p>
@@ -151,7 +151,7 @@ public interface FileContent extends Clo
      *
      * @return An input stream to read the file's content from.  The input
      *         stream is buffered, so there is no need to wrap it in a
-     *         <code>BufferedInputStream</code>.
+     *         {@code BufferedInputStream}.
      * @throws FileSystemException If the file does not exist, or is being read, or is being
written,
      *                             or on error opening the stream.
      */
@@ -169,7 +169,7 @@ public interface FileContent extends Clo
      *
      * @return An output stream to write the file's content to.  The stream is
      *         buffered, so there is no need to wrap it in a
-     *         <code>BufferedOutputStream</code>.
+     *         {@code BufferedOutputStream}.
      * @throws FileSystemException If the file is read-only, or is being read, or is being
written,
      *                             or on error opening the stream.
      */
@@ -206,7 +206,7 @@ public interface FileContent extends Clo
      * @param bAppend true if you would like to append to the file
      * @return An output stream to write the file's content to.  The stream is
      *         buffered, so there is no need to wrap it in a
-     *         <code>BufferedOutputStream</code>.
+     *         {@code BufferedOutputStream}.
      * @throws FileSystemException If the file is read-only, or is being read, or is being
written,
      *                             or on error opening the stream.
      */

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileName.java Mon
Jul 16 14:40:49 2012
@@ -42,7 +42,7 @@ public interface FileName extends Compar
     /**
      * Returns the base name of this file.  The base name is the last element
      * of the file name.  For example the base name of
-     * <code>/somefolder/somefile</code> is <code>somefile</code>.
+     * {@code /somefolder/somefile} is {@code somefile}.
      * <p/>
      * <p>The root file of a file system has an empty base name.
      *
@@ -52,11 +52,11 @@ public interface FileName extends Compar
 
     /**
      * Returns the absolute path of this file, within its file system.  This
-     * path is normalized, so that <code>.</code> and <code>..</code>
elements
-     * have been removed.  Also, the path only contains <code>/</code> as its
-     * separator character.  The path always starts with <code>/</code>
+     * path is normalized, so that {@code .} and {@code ..} elements
+     * have been removed.  Also, the path only contains {@code /} as its
+     * separator character.  The path always starts with {@code /}
      * <p/>
-     * <p>The root of a file system has <code>/</code> as its absolute
path.
+     * <p>The root of a file system has {@code /} as its absolute path.
      *
      * @return The path.  Never returns null.
      */
@@ -64,11 +64,11 @@ public interface FileName extends Compar
 
     /**
      * Returns the absolute path of this file, within its file system.  This
-     * path is normalized, so that <code>.</code> and <code>..</code>
elements
-     * have been removed.  Also, the path only contains <code>/</code> as its
-     * separator character.  The path always starts with <code>/</code>
+     * path is normalized, so that {@code .} and {@code ..} elements
+     * have been removed.  Also, the path only contains {@code /} as its
+     * separator character.  The path always starts with {@code /}
      * <p/>
-     * <p>The root of a file system has <code>/</code> as its absolute
path.
+     * <p>The root of a file system has {@code /} as its absolute path.
      * <p/>
      * In contrast to {@link #getPath()} the path is decoded i.e. all %nn stuff
      * replaced by its character.
@@ -129,7 +129,7 @@ public interface FileName extends Compar
 
     /**
      * Resolves a name, relative to this file name.  Equivalent to calling
-     * <code>resolveName( path, NameScope.FILE_SYSTEM )</code>.
+     * {@code resolveName( path, NameScope.FILE_SYSTEM )}.
      *
      * @param name The name to resolve.
      * @return A {@link FileName} object representing the resolved file name.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileObject.java Mon
Jul 16 14:40:49 2012
@@ -96,7 +96,7 @@ public interface FileObject extends Comp
     /**
      * Determines if this file exists.
      *
-     * @return <code>true</code> if this file exists, <code>false</code>
if not.
+     * @return {@code true} if this file exists, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     boolean exists() throws FileSystemException;
@@ -104,7 +104,7 @@ public interface FileObject extends Comp
     /**
      * Determines if this file is executable.
      *
-     * @return <code>true</code> if this file is executable, <code>false</code>
if not.
+     * @return {@code true} if this file is executable, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     boolean isExecutable() throws FileSystemException;
@@ -112,7 +112,7 @@ public interface FileObject extends Comp
     /**
      * Determines if this file is hidden.
      *
-     * @return <code>true</code> if this file is hidden, <code>false</code>
if not.
+     * @return {@code true} if this file is hidden, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     boolean isHidden() throws FileSystemException;
@@ -120,7 +120,7 @@ public interface FileObject extends Comp
     /**
      * Determines if this file can be read.
      *
-     * @return <code>true</code> if this file is readable, <code>false</code>
if not.
+     * @return {@code true} if this file is readable, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     boolean isReadable() throws FileSystemException;
@@ -128,7 +128,7 @@ public interface FileObject extends Comp
     /**
      * Determines if this file can be written to.
      *
-     * @return <code>true</code> if this file is writeable, <code>false</code>
if not.
+     * @return {@code true} if this file is writeable, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     boolean isWriteable() throws FileSystemException;
@@ -169,7 +169,7 @@ public interface FileObject extends Comp
     FileObject[] getChildren() throws FileSystemException;
 
     /**
-     * Returns a child of this file.  Note that this method returns <code>null</code>
+     * Returns a child of this file.  Note that this method returns {@code null}
      * when the child does not exist.  This differs from
      * {@link #resolveFile( String, NameScope)} which never returns null.
      *
@@ -198,7 +198,7 @@ public interface FileObject extends Comp
      * @param executable
      *            True to allow read access, false to disallow
      * @param ownerOnly
-     *            If <code>true</code>, the permission applies only to the owner;
otherwise, it applies to everybody.
+     *            If {@code true}, the permission applies only to the owner; otherwise, it
applies to everybody.
      * @return true if the operation succeeded
      * @throws FileSystemException
      *             On error determining if this file exists.
@@ -212,7 +212,7 @@ public interface FileObject extends Comp
      * @param readable
      *            True to allow read access, false to disallow
      * @param ownerOnly
-     *            If <code>true</code>, the permission applies only to the owner;
otherwise, it applies to everybody.
+     *            If {@code true}, the permission applies only to the owner; otherwise, it
applies to everybody.
      * @return true if the operation succeeded
      * @throws FileSystemException
      *             On error determining if this file exists.
@@ -226,7 +226,7 @@ public interface FileObject extends Comp
      * @param writable
      *            True to allow read access, false to disallow
      * @param ownerOnly
-     *            If <code>true</code>, the permission applies only to the owner;
otherwise, it applies to everybody.
+     *            If {@code true}, the permission applies only to the owner; otherwise, it
applies to everybody.
      * @return true if the operation succeeded
      * @throws FileSystemException
      *             On error determining if this file exists.
@@ -236,7 +236,7 @@ public interface FileObject extends Comp
 
     /**
      * Finds a file, relative to this file.  Equivalent to calling
-     * <code>resolveFile( path, NameScope.FILE_SYSTEM )</code>.
+     * {@code resolveFile( path, NameScope.FILE_SYSTEM )}.
      *
      * @param path The path of the file to locate.  Can either be a relative
      *             path or an absolute path.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystem.java Mon
Jul 16 14:40:49 2012
@@ -65,7 +65,7 @@ public interface FileSystem
     /**
      * Gets the value of an attribute of the file system.
      * <p/>
-     * <p>TODO - change to <code>Map getAttributes()</code> instead?
+     * <p>TODO - change to {@code Map getAttributes()} instead?
      * <p/>
      * <p>TODO - define the standard attribute names, and define which attrs
      * are guaranteed to be present.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/FileSystemManager.java
Mon Jul 16 14:40:49 2012
@@ -28,7 +28,7 @@ import org.apache.commons.vfs2.operation
  * A FileSystemManager manages a set of file systems.  This interface is
  * used to locate a {@link FileObject} by name from one of those file systems.
  * <p/>
- * <p>To locate a {@link FileObject}, use one of the <code>resolveFile()</code>
+ * <p>To locate a {@link FileObject}, use one of the {@code resolveFile()}
  * methods.</p>
  * <p/>
  * <h4><a name="naming">File Naming</a></h4>
@@ -38,7 +38,7 @@ import org.apache.commons.vfs2.operation
  * <ul>
  * <p/>
  * <li><p>Absolute URI.  These must start with a scheme, such as
- * <code>file:</code> or <code>ftp:</code>, followed by a scheme
dependent
+ * {@code file:} or {@code ftp:}, followed by a scheme dependent
  * file name.  Some examples:</p>
  * <pre>
  * file:/c:/somefile
@@ -46,21 +46,21 @@ import org.apache.commons.vfs2.operation
  * </pre>
  * <p/>
  * <li><p>Absolute local file name.  For example,
- * <code>/home/someuser/a-file</code> or <code>c:\dir\somefile.html</code>.
+ * {@code /home/someuser/a-file} or {@code c:\dir\somefile.html}.
  * Elements in the name can be separated using any of the following
- * characters: <code>/</code>, <code>\</code>, or the native file
separator
+ * characters: {@code /}, {@code \}, or the native file separator
  * character. For example, the following file names are the same:</p>
  * <pre>
  * c:\somedir\somefile.xml
  * c:/somedir/somefile.xml
  * </pre>
  * <p/>
- * <li><p>Relative path.  For example: <code>../somefile</code> or
- * <code>somedir/file.txt</code>.   The file system manager resolves relative
+ * <li><p>Relative path.  For example: {@code ../somefile} or
+ * {@code somedir/file.txt}.   The file system manager resolves relative
  * paths against its <i>base file</i>.  Elements in the relative path can be
- * separated using <code>/</code>, <code>\</code>, or file system
specific
- * separator characters.  Relative paths may also contain <code>..</code> and
- * <code>.</code> elements.  See {@link FileObject#resolveFile} for more
+ * separated using {@code /}, {@code \}, or file system specific
+ * separator characters.  Relative paths may also contain {@code ..} and
+ * {@code .} elements.  See {@link FileObject#resolveFile} for more
  * details.</p>
  * <p/>
  * </ul>
@@ -76,7 +76,7 @@ public interface FileSystemManager
 
     /**
      * Locates a file by name.  Equivalent to calling
-     * <code>resolveFile(uri, getBaseName())</code>.
+     * {@code resolveFile(uri, getBaseName())}.
      *
      * @param name The name of the file.
      * @return The file.  Never returns null.
@@ -86,7 +86,7 @@ public interface FileSystemManager
 
     /**
      * Locates a file by name.  Equivalent to calling
-     * <code>resolveFile(uri, getBaseName())</code>.
+     * {@code resolveFile(uri, getBaseName())}.
      *
      * @param name              The name of the file.
      * @param fileSystemOptions The FileSystemOptions used for FileSystem creation
@@ -100,7 +100,7 @@ public interface FileSystemManager
      * Locates a file by name.  The name is resolved as described
      * <a href="#naming">above</a>.  That is, the name can be either
      * an absolute URI, an absolute file name, or a relative path to
-     * be resolved against <code>baseFile</code>.
+     * be resolved against {@code baseFile}.
      * <p/>
      * <p>Note that the file does not have to exist when this method is called.
      *
@@ -126,7 +126,7 @@ public interface FileSystemManager
 
     /**
      * Resolves a name, relative to this file name.  Equivalent to calling
-     * <code>resolveName( path, NameScope.FILE_SYSTEM )</code>.
+     * {@code resolveName( path, NameScope.FILE_SYSTEM )}.
      *
      * @param root the base filename
      * @param name The name to resolve.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/NameScope.java Mon
Jul 16 14:40:49 2012
@@ -52,9 +52,9 @@ public enum NameScope
      * If a relative name is supplied, then it is resolved relative to the base
      * file.
      * <p/>
-     * <p>The path may use any mix of <code>/</code>, <code>\</code>,
or file
+     * <p>The path may use any mix of {@code /}, {@code \}, or file
      * system specific separators to separate elements in the path.  It may
-     * also contain <code>.</code> and <code>..</code> elements.
+     * also contain {@code .} and {@code ..} elements.
      * <p/>
      * <p>A path is considered absolute if it starts with a separator character,
      * and relative if it does not.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
Mon Jul 16 14:40:49 2012
@@ -86,7 +86,7 @@ public interface RandomAccessContent ext
      *            the offset position, measured in bytes from the beginning of the file,
at which to set the file
      *            pointer.
      * @throws IOException
-     *             if <code>pos</code> is less than <code>0</code>
or if an I/O error occurs.
+     *             if {@code pos} is less than {@code 0} or if an I/O error occurs.
      */
     void seek(long pos) throws IOException;
 

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java
Mon Jul 16 14:40:49 2012
@@ -35,14 +35,14 @@ public interface FileOperations
 
     /**
      * @param operationClass the operation Class.
-     * @return a operation implementing the given <code>operationClass</code>
+     * @return a operation implementing the given {@code operationClass}
      * @throws FileSystemException if an error occus.
      */
     FileOperation getOperation(Class<? extends FileOperation> operationClass) throws
FileSystemException;
 
     /**
      * @param operationClass the operation Class.
-     * @return if a operation <code>operationClass</code> is available
+     * @return if a operation {@code operationClass} is available
      * @throws FileSystemException if an error ocurs.
      */
     boolean hasOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
Mon Jul 16 14:40:49 2012
@@ -250,7 +250,7 @@ public abstract class AbstractFileObject
      * Lists the children of this file.  Is only called if {@link #doGetType}
      * returns {@link FileType#FOLDER}.  The return value of this method
      * is cached, so the implementation can be expensive.<br>
-     * Other than <code>doListChildren</code> you could return FileObject's to
e.g. reinitialize the
+     * Other than {@code doListChildren} you could return FileObject's to e.g. reinitialize
the
      * type of the file.<br>
      * (Introduced for Webdav: "permission denied on resource" during getType())
      * @return The children of this FileObject.
@@ -600,7 +600,7 @@ public abstract class AbstractFileObject
     /**
      * Determines if this file is executable.
      *
-     * @return {@code true} if this file is executable, <code>false</code> if
not.
+     * @return {@code true} if this file is executable, {@code false} if not.
      * @throws FileSystemException On error determining if this file exists.
      */
     public boolean isExecutable() throws FileSystemException
@@ -1372,7 +1372,7 @@ public abstract class AbstractFileObject
     }
 
     /**
-     * Checks if this fileObject is the same file as <code>destFile</code> just
with a different
+     * Checks if this fileObject is the same file as {@code destFile} just with a different
      * name.<br />
      * E.g. for case insensitive filesystems like windows.
      * @param destFile The file to compare to.
@@ -1386,7 +1386,7 @@ public abstract class AbstractFileObject
     }
 
     /**
-     * Checks if this fileObject is the same file as <code>destFile</code> just
with a different
+     * Checks if this fileObject is the same file as {@code destFile} just with a different
      * name.<br />
      * E.g. for case insensitive filesystems like windows.
      * @param destFile The file to compare to.
@@ -1399,7 +1399,7 @@ public abstract class AbstractFileObject
     }
 
     /**
-     * Queries the object if a simple rename to the filename of <code>newfile</code>
+     * Queries the object if a simple rename to the filename of {@code newfile}
      * is possible.
      *
      * @param newfile the new filename

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/AbstractFileProvider.java
Mon Jul 16 14:40:49 2012
@@ -174,7 +174,7 @@ public abstract class AbstractFileProvid
     /**
      * Parses an absolute URI.
      *
-     * @param base The base file - if null the <code>uri</code> needs to be absolute
+     * @param base The base file - if null the {@code uri} needs to be absolute
      * @param uri The URI to parse.
      * @return The FileName.
      * @throws FileSystemException if an error occurs.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/compressed/CompressedFileFileObject.java
Mon Jul 16 14:40:49 2012
@@ -50,7 +50,7 @@ public abstract class CompressedFileFile
     /**
      * Determines if this file can be written to.
      *
-     * @return <code>true</code> if this file is writeable, <code>false</code>
if not.
+     * @return {@code true} if this file is writeable, {@code false} if not.
      * @throws FileSystemException if an error occurs.
      */
     @Override

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=1362066&r1=1362065&r2=1362066&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
Mon Jul 16 14:40:49 2012
@@ -216,7 +216,7 @@ public final class FtpFileSystemConfigBu
     /**
      * Sets the timeout for the initial control connection.
      * <p>
-     * If you set the connectTimeout to <code>null</code> no connectTimeout will
be set.
+     * If you set the connectTimeout to {@code null} no connectTimeout will be set.
      * </p>
      *
      * @param opts The FileSystemOptions.
@@ -241,7 +241,7 @@ public final class FtpFileSystemConfigBu
 
     /**
      * set the data timeout for the ftp client.<br />
-     * If you set the dataTimeout to <code>null</code> no dataTimeout will be
set on the
+     * If you set the dataTimeout to {@code null} no dataTimeout will be set on the
      * ftp client.
      *
      * @param opts The FileSystemOptions.
@@ -362,7 +362,7 @@ public final class FtpFileSystemConfigBu
 
     /**
      * Sets the socket timeout for the FTP client.<br />
-     * If you set the socketTimeout to <code>null</code> no socketTimeout will
be set on the
+     * If you set the socketTimeout to {@code null} no socketTimeout will be set on the
      * ftp client.
      *
      * @param opts The FileSystem options.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsFileSystemConfigBuilder.java
Mon Jul 16 14:40:49 2012
@@ -195,7 +195,7 @@ public final class FtpsFileSystemConfigB
 
     /**
      * set the data timeout for the ftp client.<br />
-     * If you set the dataTimeout to <code>null</code> no dataTimeout will be
set on the
+     * If you set the dataTimeout to {@code null} no dataTimeout will be set on the
      * ftp client.
      *
      * @param opts  The FileSystemOptions.

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpClientFactory.java
Mon Jul 16 14:40:49 2012
@@ -251,15 +251,15 @@ public final class SftpClientFactory
      * Finds the .ssh directory.
      * <p>The lookup order is:</p>
      * <ol>
-     * <li>The system property <code>vfs.sftp.sshdir</code> (the override
+     * <li>The system property {@code vfs.sftp.sshdir} (the override
      * mechanism)</li>
-     * <li><code>{user.home}/.ssh</code></li>
+     * <li>{@code {user.home}/.ssh}</li>
      * <li>On Windows only: C:\cygwin\home\{user.name}\.ssh</li>
      * <li>The current directory, as a last resort.</li>
      * <ol>
      * <p/>
      * Windows Notes:
-     * The default installation directory for Cygwin is <code>C:\cygwin</code>.
+     * The default installation directory for Cygwin is {@code C:\cygwin}.
      * On my set up (Gary here), I have Cygwin in C:\bin\cygwin, not the default.
      * Also, my .ssh directory was created in the {user.home} directory.
      * </p>

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/tar/TarFileObject.java
Mon Jul 16 14:40:49 2012
@@ -84,7 +84,7 @@ public class TarFileObject extends Abstr
     /**
      * Determines if this file can be written to.
      *
-     * @return <code>true</code> if this file is writeable, <code>false</code>
if not.
+     * @return {@code true} if this file is writeable, {@code false} if not.
      * @throws FileSystemException if an error occurs.
      */
     @Override

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/url/UrlFileNameParser.java
Mon Jul 16 14:40:49 2012
@@ -65,7 +65,7 @@ public class UrlFileNameParser extends A
 
     /**
      * Guess is the given filename is a url with host or not. VFS treats such urls differently.<br
/>
-     * A filename is url-based if the base is a <code>URLFileName</code> or there
are only 2 slashes
+     * A filename is url-based if the base is a {@code URLFileName} or there are only 2 slashes
      * after the scheme.<br/>
      * e.g: http://host/path, file:/path/to/file, file:///path/to/file
      */

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/webdav/ExceptionConverter.java
Mon Jul 16 14:40:49 2012
@@ -26,7 +26,7 @@ import org.apache.jackrabbit.webdav.xml.
 import org.w3c.dom.Element;
 
 /**
- * <code>ExceptionConverter</code> converts WebDAV exceptions into FileSystemExceptions.
+ * {@code ExceptionConverter} converts WebDAV exceptions into FileSystemExceptions.
  * @since 2.0
  */
 public final class ExceptionConverter

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/provider/zip/ZipFileObject.java
Mon Jul 16 14:40:49 2012
@@ -87,7 +87,7 @@ public class ZipFileObject extends Abstr
     /**
      * Determines if this file can be written to.
      *
-     * @return <code>true</code> if this file is writeable, <code>false</code>
if not.
+     * @return {@code true} if this file is writeable, {@code false} if not.
      * @throws FileSystemException if an error occurs.
      */
     @Override

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
(original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/util/WeakRefFileListener.java
Mon Jul 16 14:40:49 2012
@@ -43,7 +43,7 @@ public class WeakRefFileListener impleme
     }
 
     /**
-     * This will install the <code>listener</code> at the given <code>file</code>.
+     * This will install the {@code listener} at the given {@code file}.
      * @param file The FileObject to listen on.
      * @param listener The FileListener
      */

Modified: commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java?rev=1362066&r1=1362065&r2=1362066&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
(original)
+++ commons/proper/vfs/trunk/core/src/test/java/org/apache/commons/vfs2/test/AbstractProviderTestCase.java
Mon Jul 16 14:40:49 2012
@@ -112,7 +112,7 @@ public abstract class AbstractProviderTe
 
     /**
      * some provider config do some post-initialization in getBaseTestFolder.
-     * This is a hack to allow access to this code for <code>createManager</code>
+     * This is a hack to allow access to this code for {@code createManager}
      */
     public FileObject getBaseTestFolder(FileSystemManager fs) throws Exception
     {



Mime
View raw message