[jboss-svn-commits] JBL Code SVN: r8776 - in labs/jbossesb/trunk/product/core: listeners/src/org/jboss/soa/esb/actions listeners/src/org/jboss/soa/esb/listeners/config services/src/org/jboss/soa/esb/services/registry services/src/org/jboss/soa/esb/services/routing/cbr

[jboss-svn-commits at lists.jboss.org]

Author: kurt.stam at jboss.com
Date: 2007-01-09 12:27:51 -0500 (Tue, 09 Jan 2007)
New Revision: 8776

Modified:
   labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/actions/CbrProxyAction.java
   labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/config/ConfigurationController.java
   labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/registry/Registry.java
   labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/routing/cbr/ContentBasedRouter.java
Log:
Fixing javadoc.

Modified: labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/actions/CbrProxyAction.java
===================================================================
--- labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/actions/CbrProxyAction.java	2007-01-09 16:52:03 UTC (rev 8775)
+++ labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/actions/CbrProxyAction.java	2007-01-09 17:27:51 UTC (rev 8776)
@@ -110,7 +110,7 @@
     public Message noOperation(Message message) { return message; } 
     
     /** By default this process method forwards this request to routeAndDeliver.
-     * @see routeAndDeliver(Message message).
+     * @see #routeAndDeliver(Message message).
      * 
      * @param message - the message to be routed.
      * @return        - the same message as was passed in.
@@ -191,7 +191,7 @@
     /**
      * Do *not* route, just deliver. Pulls the destinationServices from the message and deliver the message to the destination(s).
      * @param message 
-     * @return
+     * @return the message that was passed in.
      */
     @SuppressWarnings("unchecked")
 	public Message deliver(Message message) 

Modified: labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/config/ConfigurationController.java
===================================================================
--- labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/config/ConfigurationController.java	2007-01-09 16:52:03 UTC (rev 8775)
+++ labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/config/ConfigurationController.java	2007-01-09 17:27:51 UTC (rev 8776)
@@ -135,8 +135,7 @@
 	}
 	
 	/**
-	 * Setter, to request the end of processing.
-	 * @param isEndRequested
+	 * To request the end of processing.
 	 */
 	public void requestEnd() {
 		mIsEndRequested = true;

Modified: labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/registry/Registry.java
===================================================================
--- labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/registry/Registry.java	2007-01-09 16:52:03 UTC (rev 8775)
+++ labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/registry/Registry.java	2007-01-09 17:27:51 UTC (rev 8776)
@@ -43,21 +43,21 @@
 	 * Registers an EPR under the specified category and service. If the specified service does
 	 * not exist, it will be created at the same time.
 	 * 
-	 * @param category           - name of the category to which the service belongs.
-	 * @param serviceName        - name of the service to which the EPS belongs.
-	 * @param serviceDescription - human readable description of the service, 
+	 * @param serviceCategoryName - name of the category to which the service belongs.
+	 * @param serviceName         - name of the service to which the EPS belongs.
+	 * @param serviceDescription  - human readable description of the service, 
 	 * 							   only used when it the service does not yet exist.
-	 * @param epr				 - the EndPointReference (EPR) that needs to be registered.
-	 * @param eprDescription	 - human readable description of the EPR
+	 * @param epr				  - the EndPointReference (EPR) that needs to be registered.
+	 * @param eprDescription	  - human readable description of the EPR
 	 * @throws RegistryException
 	 */
 	public void registerEPR(String serviceCategoryName, String serviceName, String serviceDescription, EPR epr, String eprDescription) 
 	throws RegistryException;
 	/**
 	 * Removes an EPR from the Registry. 
-	 * @param category           - name of the category to which the service belongs.
-	 * @param serviceName        - name of the service to which the EPS belongs.
-	 * @param epr                - the EndPointReference (EPR) that needs to be unregistered.
+	 * @param serviceCategoryName - name of the category to which the service belongs.
+	 * @param serviceName         - name of the service to which the EPS belongs.
+	 * @param epr                 - the EndPointReference (EPR) that needs to be unregistered.
 	 * @throws RegistryException
 	 */
 	public void unRegisterEPR(String serviceCategoryName, String serviceName, EPR epr) throws RegistryException;
@@ -70,7 +70,7 @@
 	/**
 	 * Find all services that belong to the supplied category. 
 	 * 
-	 * @param category            - name of the category to which the service belongs.
+	 * @param serviceCategoryName - name of the category to which the service belongs.
 	 * @return Collection of Strings containing the service names
 	 * @throws RegistryException
 	 */
@@ -78,7 +78,7 @@
 	/**
 	 * Finds all the EPRs that belong to a specific category and service combination.
 	 * 
-	 * @param category            - name of the category to which the service belongs.
+	 * @param serviceCategoryName - name of the category to which the service belongs.
 	 * @param serviceName         - name of the service to which the EPS belongs.
 	 * @return Collection of EPRs.
 	 * @throws RegistryException
@@ -87,7 +87,7 @@
 	/**
 	 * Returns the first EPR in the list that belong to a specific category and service combination.
 	 * 
-	 * @param category            - name of the category to which the service belongs.
+	 * @param serviceCategoryName - name of the category to which the service belongs.
 	 * @param serviceName         - name of the service to which the EPS belongs.
 	 * @return EPR.
 	 * @throws RegistryException

Modified: labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/routing/cbr/ContentBasedRouter.java
===================================================================
--- labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/routing/cbr/ContentBasedRouter.java	2007-01-09 16:52:03 UTC (rev 8775)
+++ labs/jbossesb/trunk/product/core/services/src/org/jboss/soa/esb/services/routing/cbr/ContentBasedRouter.java	2007-01-09 17:27:51 UTC (rev 8776)
@@ -40,7 +40,7 @@
 	 * @param ruleSet      - String reference to a file which contains a ruleSet.
 	 * @param ruleLanguage - String reference to a file which contais a custom rule language definition
 	 * @param message      - Message that needs routing.
-	 * @return
+	 * @return List of routing destinations.
 	 */
 	public abstract List<String> route(String ruleSet, String ruleLanguage, boolean ruleReload, Message message);
 	/**
@@ -48,7 +48,7 @@
 	 * 
 	 * @param ruleSet      - String reference to a file which contains a ruleSet.
 	 * @param message      - Message that needs routing.
-	 * @return
+	 * @return List of routing destinations.
 	 */
 	public abstract List<String> route(String ruleSet, boolean ruleReload, Message message);
 }