svn commit: r1304945 - /archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java

[olamy]

Author: olamy
Date: Sat Mar 24 22:06:43 2012
New Revision: 1304945

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

Modified:
    
archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java

Modified: 
archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
URL: 
http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java?rev=1304945&r1=1304944&r2=1304945&view=diff
==============================================================================
--- 
archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
 (original)
+++ 
archiva/trunk/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
 Sat Mar 24 22:06:43 2012
@@ -89,6 +89,9 @@ public interface BrowseService
     @GET
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
+    /**
+     * @return List of managed repositories current user can read
+     */
     List<ManagedRepository> getUserRepositories()
         throws ArchivaRestServiceException;
 
@@ -96,6 +99,10 @@ public interface BrowseService
     @GET
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
+    /**
+     * return the dependency Tree for an artifacts
+     * <b>the List result has only one entry</b>
+     */
     List<TreeEntry> getTreeEntries( @PathParam( "g" ) String groupId, 
@PathParam( "a" ) String artifactId,
                                     @PathParam( "v" ) String version,
                                     @QueryParam( "repositoryId" ) String 
repositoryId )
@@ -105,6 +112,9 @@ public interface BrowseService
     @GET
     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
     @RedbackAuthorization( noPermission = true, noRestriction = true )
+    /**
+     * List of artifacts using the artifact passed in parameter.
+     */
     List<Artifact> getDependees( @PathParam( "g" ) String groupId, @PathParam( 
"a" ) String artifactId,
                                  @PathParam( "v" ) String version, 
@QueryParam( "repositoryId" ) String repositoryId )
         throws ArchivaRestServiceException;