From: Olivier Lamy <olamy@apache.org>
Date: Sat, 24 Mar 2012 22:06:43 +0000 (+0000)
Subject: add javadoc
X-Git-Tag: archiva-1.4-M3~959
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=7461a332bc5c76c8154c525d334090ca59992627;p=archiva.git

add javadoc

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1304945 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java b/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
index 7a47163ba..5b2be0978 100644
--- a/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
+++ b/archiva-modules/archiva-web/archiva-rest/archiva-rest-api/src/main/java/org/apache/archiva/rest/api/services/BrowseService.java
@@ -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;