java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java | 92 +++++-----
1 file changed, 46 insertions(+), 46 deletions(-)
New commits:
commit b439d123c4606918600bd3b46f88d7648ef3de30
Author: Tomas Lestach <tlestach(a)redhat.com>
Date: Mon Oct 24 11:47:19 2011 +0200
682845 - fix apidoc of repository related APIs
diff --git a/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java b/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java
index b4193cb..4076167 100644
--- a/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java
+++ b/java/code/src/com/redhat/rhn/frontend/xmlrpc/channel/software/ChannelSoftwareHandler.java
@@ -2346,18 +2346,18 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Creates a ContentSource (repo)
- * @param sessionKey WebSession containing User information.
+ * Creates a repository
+ * @param sessionKey Session containing user information.
* @param label of the repo to be created
* @param type of the repo (YUM only for now)
* @param url of the repo
- * @return the new ContentSource
+ * @return new ContentSource
*
- * @xmlrpc.doc Creates a ContentSource (repo)
+ * @xmlrpc.doc Creates a repository
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("string", "label", "label of repo wanted")
- * @xmlrpc.param #param_desc("string", "type", "type of repo wanted")
- * @xmlrpc.param #param_desc("string", "url", "url of repo wanted")
+ * @xmlrpc.param #param_desc("string", "label", "repository label")
+ * @xmlrpc.param #param_desc("string", "type", "repository type (only YUM is supported)")
+ * @xmlrpc.param #param_desc("string", "url", "repository url")
* @xmlrpc.returntype $ContentSourceSerializer
**/
public ContentSource createRepo(String sessionKey, String label, String type,
@@ -2377,12 +2377,12 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Removes a ContentSource (repo)
- * @param sessionKey WebSession containing User information.
+ * Removes a repository
+ * @param sessionKey Session containing user information.
* @param id of the repo to be removed
* @return Integer 1 on success
*
- * @xmlrpc.doc Creates a ContentSource (repo)
+ * @xmlrpc.doc Removes a repository
* @xmlrpc.param #session_key()
* @xmlrpc.param #param_desc("long", "id", "ID of repo to be removed")
* @xmlrpc.returntype #return_int_success()
@@ -2396,12 +2396,12 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Removes a ContentSource (repo)
- * @param sessionKey WebSession containing User information.
+ * Removes a repository
+ * @param sessionKey Session containing user information.
* @param label of the repo to be removed
* @return Integer 1 on success
*
- * @xmlrpc.doc Creates a ContentSource (repo)
+ * @xmlrpc.doc Removes a repository
* @xmlrpc.param #session_key()
* @xmlrpc.param #param_desc("string", "label", "label of repo to be removed")
* @xmlrpc.returntype #return_int_success()
@@ -2415,16 +2415,16 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Associates a ContentSource (repo) with a channel
- * @param sessionKey WebSession containing User information.
+ * Associates a repository with a channel
+ * @param sessionKey Session containing user information.
* @param chanLabel of the channel to use
* @param repoLabel of the repo to associate
* @return the channel with the newly associated repo
*
- * @xmlrpc.doc Associates a ContentSource (repo) with a channel
+ * @xmlrpc.doc Associates a repository with a channel
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("string", "chanLabel", "of the channel to use")
- * @xmlrpc.param #param_desc("string", "repoLabel", "of the repo to associate")
+ * @xmlrpc.param #param_desc("string", "channelLabel", "channel label")
+ * @xmlrpc.param #param_desc("string", "repoLabel", "repository label")
* @xmlrpc.returntype $ChannelSerializer
**/
public Channel associateRepo(String sessionKey, String chanLabel, String repoLabel) {
@@ -2440,16 +2440,16 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Disassociates a ContentSource (repo) with a channel
- * @param sessionKey WebSession containing User information.
+ * Disassociates a repository from a channel
+ * @param sessionKey Session containing user information.
* @param chanLabel of the channel to use
* @param repoLabel of the repo to disassociate
* @return the channel minus the disassociated repo
*
- * @xmlrpc.doc Disassociates a ContentSource (repo) with a channel
+ * @xmlrpc.doc Disassociates a repository from a channel
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("string", "chanLabel", "of the channel to use")
- * @xmlrpc.param #param_desc("string", "repoLabel", "of the repo to disassociate")
+ * @xmlrpc.param #param_desc("string", "channelLabel", "channel label")
+ * @xmlrpc.param #param_desc("string", "repoLabel", "repository label")
* @xmlrpc.returntype $ChannelSerializer
**/
public Channel disassociateRepo(String sessionKey, String chanLabel, String repoLabel) {
@@ -2467,16 +2467,16 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Updates the ContentSource (repo) source URL
- * @param sessionKey WebSession containing User information.
+ * Updates repository source URL
+ * @param sessionKey Session containing user information.
* @param id ID of the repo
* @param url new URL to use
* @return the updated repo
*
- * @xmlrpc.doc Updates the ContentSource (repo) source URL
+ * @xmlrpc.doc Updates repository source URL
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("Long", "id", "of the repo to use")
- * @xmlrpc.param #param_desc("string", "url", "new URL to use")
+ * @xmlrpc.param #param_desc("int", "id", "repository id")
+ * @xmlrpc.param #param_desc("string", "url", "repository url")
* @xmlrpc.returntype $ContentSourceSerializer
**/
public ContentSource updateRepoUrl(String sessionKey, Integer id, String url) {
@@ -2488,16 +2488,16 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Updates the ContentSource (repo) source URL
- * @param sessionKey WebSession containing User information.
+ * Updates repository source URL
+ * @param sessionKey Session containing user information.
* @param label of the repo to use
* @param url new URL to use
* @return the updated repo
*
- * @xmlrpc.doc Updates the ContentSource (repo) source URL
+ * @xmlrpc.doc Updates repository source URL
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("string", "label", "of the repo to use")
- * @xmlrpc.param #param_desc("string", "url", "new URL to use")
+ * @xmlrpc.param #param_desc("string", "label", "repository label")
+ * @xmlrpc.param #param_desc("string", "url", "repository url")
* @xmlrpc.returntype $ContentSourceSerializer
**/
public ContentSource updateRepoUrl(String sessionKey, String label, String url) {
@@ -2509,16 +2509,16 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Updates the ContentSource's (repo) label
- * @param sessionKey WebSession containing User information.
+ * Updates repository label
+ * @param sessionKey Session containing user information.
* @param id ID of the repo
* @param label new label
* @return the updated repo
*
- * @xmlrpc.doc Updates the ContentSource's (repo) label
+ * @xmlrpc.doc Updates repository label
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("Long", "id", "of the repo to use")
- * @xmlrpc.param #param_desc("string", "label", "new label to use")
+ * @xmlrpc.param #param_desc("int", "id", "repository id")
+ * @xmlrpc.param #param_desc("string", "label", "new repository label")
* @xmlrpc.returntype $ContentSourceSerializer
**/
public ContentSource updateRepoLabel(String sessionKey, Integer id, String label) {
@@ -2530,8 +2530,8 @@ public class ChannelSoftwareHandler extends BaseHandler {
}
/**
- * Updates a ContentSource (repo)
- * @param sessionKey WebSession containing User information.
+ * Updates a repository
+ * @param sessionKey Session containing user information.
* @param id ID of the repo
* @param label new label
* @param url new URL
@@ -2539,9 +2539,9 @@ public class ChannelSoftwareHandler extends BaseHandler {
*
* @xmlrpc.doc Updates a ContentSource (repo)
* @xmlrpc.param #session_key()
- * @xmlrpc.param #param_desc("Long", "id", "of the repo to use")
- * @xmlrpc.param #param_desc("string", "label", "new label to use")
- * @xmlrpc.param #param_desc("string", "url", "new URL to use")
+ * @xmlrpc.param #param_desc("int", "id", "repository id")
+ * @xmlrpc.param #param_desc("string", "label", "new repository label")
+ * @xmlrpc.param #param_desc("string", "url", "new repository URL")
* @xmlrpc.returntype $ContentSourceSerializer
**/
public ContentSource updateRepo(String sessionKey, Integer id, String label,
@@ -2556,11 +2556,11 @@ public class ChannelSoftwareHandler extends BaseHandler {
/**
* Returns the details of the given repo
- * @param sessionKey WebSession containing User information.
+ * @param sessionKey Session containing user information.
* @param repoLabel Label of repo whose details are sought.
* @return the repo requested.
*
- * @xmlrpc.doc Returns details of the given repo
+ * @xmlrpc.doc Returns details of the given repository
* @xmlrpc.param #session_key()
* @xmlrpc.param #param_desc("string", "repoLabel", "repo to query")
* @xmlrpc.returntype
@@ -2572,7 +2572,7 @@ public class ChannelSoftwareHandler extends BaseHandler {
/**
* Returns the details of the given repo
- * @param sessionKey WebSession containing User information.
+ * @param sessionKey Session containing user information.
* @param id ID of repo whose details are sought.
* @return the repo requested.
*