Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-10 15:35:49 +01:00
Code Issues Packages Projects Releases Activity

improve javadoc of repository resource

Browse Source
This commit is contained in:
Sebastian Sdorra
2012-01-11 08:30:24 +01:00
parent 75f3e28fe0
commit 213304cd51
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryResource.java
View File

@@ -222,7 +222,7 @@ public class RepositoryResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Returns a repository.<br /> * Returns the {@link Repository} with the specified id.<br />
* <br /> * <br />
* Status codes: * Status codes:
* <ul> * <ul>
@@ -261,7 +261,7 @@ public class RepositoryResource
* @param sortby sort parameter * @param sortby sort parameter
* @param desc sort direction desc or aesc * @param desc sort direction desc or aesc
* *
* @return * @return all repositories
*/ */
@GET @GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@@ -292,7 +292,7 @@ public class RepositoryResource
* @param revision the revision of the file * @param revision the revision of the file
* @param path the path of the file * @param path the path of the file
* *
* @return * @return a annotate/blame view for the given path
* *
* @throws IOException * @throws IOException
* @throws RepositoryException * @throws RepositoryException
@@ -356,7 +356,7 @@ public class RepositoryResource
* @param revision the revision of the file * @param revision the revision of the file
* @param path the path of the folder * @param path the path of the folder
* *
* @return * @return a list of folders and files for the given folder
* *
* @throws IOException * @throws IOException
* @throws RepositoryException * @throws RepositoryException
@@ -399,7 +399,7 @@ public class RepositoryResource
} }
/** /**
* Returns a repository.<br /> * Returns the {@link Repository} with the specified type and name.<br />
* <br /> * <br />
* Status codes: * Status codes:
* <ul> * <ul>
@@ -439,24 +439,24 @@ public class RepositoryResource
} }
/** /**
* Returns a list of {@link Changeset} for the given repository.<br /> * Returns a list of {@link Changeset} for the given repository.<br />
* <br /> * <br />
* Status codes: * Status codes:
* <ul> * <ul>
* <li>200 get successful</li> * <li>200 get successful</li>
* <li>400 bad request, the changeset feature is not * <li>400 bad request, the changeset feature is not
* supported by this type of repositories.</li> * supported by this type of repositories.</li>
* <li>404 not found, if the repository or the path could not be found</li> * <li>404 not found, if the repository or the path could not be found</li>
* <li>500 internal server error</li> * <li>500 internal server error</li>
* </ul> * </ul>
* *
* @param id the id of the repository * @param id the id of the repository
* @param path path of a file * @param path path of a file
* @param revision the revision of the file specified by the path parameter * @param revision the revision of the file specified by the path parameter
* @param start the start value for paging * @param start the start value for paging
* @param limit the limit value for paging * @param limit the limit value for paging
* *
* @return * @return a list of {@link Changeset} for the given repository
* *
* @throws IOException * @throws IOException
* @throws RepositoryException * @throws RepositoryException
@@ -525,7 +525,7 @@ public class RepositoryResource
* @param revision the revision of the file * @param revision the revision of the file
* @param path path to the file * @param path path to the file
* *
* @return * @return the content of a file
*/ */
@GET @GET
@Path("{id}/content") @Path("{id}/content")
@@ -590,7 +590,7 @@ public class RepositoryResource
* @param revision the revision of the file * @param revision the revision of the file
* @param path path to the file * @param path path to the file
* *
* @return * @return the modifications of a {@link Changeset}
* *
* @throws IOException * @throws IOException
* @throws RepositoryException * @throws RepositoryException