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 7a47163ba82f7e16c73d71bb66facba953193de0..5b2be0978651f16f89213fceac755915dc152ef2 100644 (file)
--- 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;