svn commit: r740737 - /jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java

[an...@apache.org]

Author: angela
Date: Wed Feb  4 13:45:53 2009
New Revision: 740737

URL: http://svn.apache.org/viewvc?rev=740737&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java

Modified: jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java?rev=740737&r1=740736&r2=740737&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java (original)
+++ jackrabbit/trunk/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/DavLocatorFactory.java Wed Feb  4 13:45:53 2009
@@ -30,7 +30,7 @@
      * the 'prefix'. Please note, that in contrast to
      * {@link DavLocatorFactory#createResourceLocator(String, String, String)} the
      * href is expected to be URL encoded.
-     * @return
+     * @return a new resource locator.
      */
     public DavResourceLocator createResourceLocator(String prefix, String href);
 
@@ -44,16 +44,19 @@
      * @param workspacePath the first segment of the URIs path indicating the
      * workspace. The implementation may allow a empty String if workspaces
      * are not supported.
-     * @param resourcePath the URL decoded resource path
-     * @return
+     * @param resourcePath the URL decoded resource path.
+     * @return a new resource locator.
      */
     public DavResourceLocator createResourceLocator(String prefix, String workspacePath, String resourcePath);
 
     /**
      *
-     * @param prefix
-     * @param workspacePath
-     * @param path
+     * @param prefix String consisting of  [scheme:][//authority][path] where
+     * path defines the path to the {@link DavResourceLocator#isRootLocation root location}.
+     * @param workspacePath the first segment of the URIs path indicating the
+     * workspace. The implementation may allow a empty String if workspaces
+     * are not supported.
+     * @param path the URL decoded path.
      * @param isResourcePath If true this method returns the same as
      * {@link DavLocatorFactory#createResourceLocator(String, String, String)},
      * otherwise the given path is treated as internal repository path.
@@ -62,7 +65,7 @@
      * to incompatibility with the URI definition (or vice versa). Note that
      * {@link DavResourceLocator#getRepositoryPath()} should in this case implement
      * the reverse operation.
-     * @return
+     * @return a new resource locator.
      * @see DavResourceLocator#getRepositoryPath()
      */
     public DavResourceLocator createResourceLocator(String prefix, String workspacePath, String path, boolean isResourcePath);