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

improve javadoc of PluginResource for the webservice documentation

Browse Source
This commit is contained in:
Sebastian Sdorra
2011-10-03 13:53:46 +02:00
parent d9ffabbf90
commit c0a83d9fcf
1 changed files with 56 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
scm-webapp/src/main/java/sonia/scm/api/rest/resources/PluginResource.java
View File

@@ -86,10 +86,14 @@ public class PluginResource
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * Installs a plugin.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @param id id of the plugin to be installed
* @param id
* *
* @return * @return
*/ */
@@ -103,10 +107,14 @@ public class PluginResource
} }
/** /**
* Method description * Uninstalls a plugin.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @param id id of the plugin to be uninstalled
* @param id
* *
* @return * @return
*/ */
@@ -120,10 +128,14 @@ public class PluginResource
} }
/** /**
* Method description * Updates a plugin.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @param id id of the plugin to be updated
* @param id
* *
* @return * @return
*/ */
@@ -139,10 +151,14 @@ public class PluginResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * Returns all plugins.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all plugins
* @return
*/ */
@GET @GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@@ -152,10 +168,14 @@ public class PluginResource
} }
/** /**
* Method description * Returns all available plugins.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all available plugins
* @return
*/ */
@GET @GET
@Path("available") @Path("available")
@@ -166,10 +186,14 @@ public class PluginResource
} }
/** /**
* Method description * Returns all plugins which are available for update.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all plugins which are available for update
* @return
*/ */
@GET @GET
@Path("updates") @Path("updates")
@@ -180,10 +204,14 @@ public class PluginResource
} }
/** /**
* Method description * Returns all installed plugins.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all installed plugins
* @return
*/ */
@GET @GET
@Path("installed") @Path("installed")
@@ -194,10 +222,14 @@ public class PluginResource
} }
/** /**
* Method description * Returns all plugins for the overview.<br />
* <br />
* <ul>
* <li>200 success</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all plugins for the overview
* @return
*/ */
@GET @GET
@Path("overview") @Path("overview")