Fixed 25742: Fixup small javadoc related errors
authorStefan Hühner <stefan.huehner@openbravo.com>
Fri, 14 Feb 2014 15:32:23 +0100
changeset 22040 b28f62b0e588
parent 22039 cac61a7acbc6
child 22041 90b0b23defc9
Fixed 25742: Fixup small javadoc related errors
modules/org.openbravo.advpaymentmngt/src-test/org/openbravo/advpaymentmngt/test/draft/TestUtility.java
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java
modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/freemarker/test/LabelTest.java
modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/test/KernelUtilTest.java
modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponent.java
modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponentProvider.java
modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseTemplateProcessor.java
modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/PasswordUIDefinition.java
modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/UIDefinition.java
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceProperty.java
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceService.java
modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonDataService.java
modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonToDataConverter.java
src/org/openbravo/authentication/AuthenticationManager.java
src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java
src/org/openbravo/erpCommon/utility/ErrorTextParser.java
src/org/openbravo/service/db/QueryTimeOutUtil.java
--- a/modules/org.openbravo.advpaymentmngt/src-test/org/openbravo/advpaymentmngt/test/draft/TestUtility.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.advpaymentmngt/src-test/org/openbravo/advpaymentmngt/test/draft/TestUtility.java	Fri Feb 14 15:32:23 2014 +0100
@@ -457,10 +457,10 @@
    * Method used to generating payment document with refund amount.
    * 
    * @param payment
-   *          . Created Payment.
+   *          Created Payment.
    * @param refundAmount
-   *          . Refund Amount need to transfer to the customer.
-   * @return. Created FIN_Payment object.
+   *          Refund Amount need to transfer to the customer.
+   * @return Created FIN_Payment object.
    * @throws Exception
    *           In case of executing invalid data.
    */
--- a/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java	Fri Feb 14 15:32:23 2014 +0100
@@ -558,12 +558,6 @@
    *          accounting dimension
    * @param salesRegion
    *          accounting dimension
-   * @param costCenter
-   *          accounting dimension
-   * @param user1
-   *          accounting dimension
-   * @param user2
-   *          accounting dimension
    */
   public static void saveGLItem(FIN_Payment payment, BigDecimal glitemAmount, GLItem glitem,
       BusinessPartner businessPartner, Product product, Project project, Campaign campaign,
@@ -669,9 +663,9 @@
    * 
    * @param vars
    *          VariablseSecureApp with the session data.
-   * @param selectedPaymentScheduleDetails
-   *          List of FIN_PaymentScheduleDetails that need to be included in the HashMap.
-   * @return A HashMap mapping the FIN_PaymentScheduleDetail's Id with the corresponding amount.
+   * @param selectedBaseOBObjects
+   *          List of bobs that need to be included in the HashMap.
+   * @return A HashMap mapping the Id with the corresponding amount.
    */
   public static <T extends BaseOBObject> HashMap<String, BigDecimal> getSelectedBaseOBObjectAmount(
       VariablesSecureApp vars, List<T> selectedBaseOBObjects, String htmlElementId)
--- a/modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/freemarker/test/LabelTest.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/freemarker/test/LabelTest.java	Fri Feb 14 15:32:23 2014 +0100
@@ -29,6 +29,7 @@
 import org.openbravo.client.kernel.Component;
 import org.openbravo.client.kernel.ComponentGenerator;
 import org.openbravo.client.kernel.ComponentProvider;
+import org.openbravo.client.kernel.I18NComponent;
 import org.openbravo.client.kernel.KernelComponentProvider;
 import org.openbravo.client.kernel.KernelConstants;
 import org.openbravo.dal.core.OBContext;
@@ -39,8 +40,8 @@
 import org.openbravo.model.ad.ui.MessageTrl;
 
 /**
- * Test the {@link labelComponent}, test that a translated label actually is used inside of the
- * label template.
+ * Test the {@link I18NComponent}, test that a translated label actually is used inside of the label
+ * template.
  * 
  * @author mtaal
  */
--- a/modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/test/KernelUtilTest.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src-test/org/openbravo/client/kernel/test/KernelUtilTest.java	Fri Feb 14 15:32:23 2014 +0100
@@ -72,7 +72,7 @@
   }
 
   /**
-   * Test generation of the version id number {@link KernelUtils#getVersionString()}.
+   * Test generation of the version id number {@link KernelUtils#getVersionParameters(Module)}.
    * 
    * @throws Exception
    */
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponent.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponent.java	Fri Feb 14 15:32:23 2014 +0100
@@ -255,8 +255,6 @@
 
   /**
    * Override this method if the component is in a different package than the module.
-   * 
-   * @return
    */
   protected String getModulePackageName() {
     return this.getClass().getPackage().getName();
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponentProvider.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseComponentProvider.java	Fri Feb 14 15:32:23 2014 +0100
@@ -88,8 +88,6 @@
 
   /**
    * Override this method if the component is in a different package than the module.
-   * 
-   * @return
    */
   protected String getModulePackageName() {
     return this.getClass().getPackage().getName();
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseTemplateProcessor.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/BaseTemplateProcessor.java	Fri Feb 14 15:32:23 2014 +0100
@@ -121,7 +121,6 @@
    * 
    * @param template
    * @param source
-   * @return
    */
   protected synchronized T createSetFreeMarkerTemplateInCache(Template template, String source) {
     final T specificTemplate = createTemplateImplementation(template, source);
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/PasswordUIDefinition.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/PasswordUIDefinition.java	Fri Feb 14 15:32:23 2014 +0100
@@ -25,8 +25,8 @@
  * both encrypted (reversible) and hashed storage of passwords.
  * 
  * @author shuehner
- * @See org.openbravo.base.model.domaintype.HashedStringDomainType
- * @See org.openbravo.base.model.domaintype.EncryptedStringDomainType
+ * @see org.openbravo.base.model.domaintype.HashedStringDomainType
+ * @see org.openbravo.base.model.domaintype.EncryptedStringDomainType
  */
 public class PasswordUIDefinition extends StringUIDefinition {
 
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/UIDefinition.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/reference/UIDefinition.java	Fri Feb 14 15:32:23 2014 +0100
@@ -363,7 +363,6 @@
    * @param field
    *          the field to generate the filter editor properties for, note it is allowed to pass
    *          null, implementors should gracefully handle this.
-   * @return
    */
   protected String getFilterEditorPropertiesProperty(Field field) {
     return "";
--- a/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceProperty.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceProperty.java	Fri Feb 14 15:32:23 2014 +0100
@@ -42,7 +42,7 @@
 import org.openbravo.model.ad.domain.Reference;
 
 /**
- * A representation of the {@link DataSourceField} which can be read from the DataSourceField table
+ * A representation of the {@link DatasourceField} which can be read from the DataSourceField table
  * or created on the basis of an existing {@link Property} from the in-memory model.
  * 
  * DataSourceProperties are passed into the data source template to generate the data source
@@ -91,7 +91,7 @@
   }
 
   /**
-   * Create a DataSourceProperty using a {@link DataSourceField} to initialize it.
+   * Create a DataSourceProperty using a {@link DatasourceField} to initialize it.
    * 
    * @param dsField
    *          the data source field used to initialize the new data source property
--- a/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceService.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/DataSourceService.java	Fri Feb 14 15:32:23 2014 +0100
@@ -58,9 +58,7 @@
   public List<DataSourceProperty> getDataSourceProperties(Map<String, Object> parameters);
 
   /**
-   * Execute a query request and return the result as a json string. For a query request the content
-   * ({@link #getPath()}) is normally empty, the query parameters can be found in the parameters map
-   * ({@link #getParameters()}).
+   * Execute a query request and return the result as a json string.
    * 
    * @param parameters
    *          the parameters often coming from the HTTP request
@@ -78,9 +76,7 @@
   public String remove(Map<String, String> parameters);
 
   /**
-   * Execute an insert action. There can be parameters in the parameter map (
-   * {@link #getParameters()}) but often the data to insert is present in the content (
-   * {@link #getPath()}).
+   * Execute an insert action.
    * 
    * @param parameters
    *          the parameters often coming from the HTTP request
@@ -91,9 +87,7 @@
   public String add(Map<String, String> parameters, String content);
 
   /**
-   * Execute an update action. There can be parameters in the parameter map (
-   * {@link #getParameters()}) but often the data to insert is present in the content (
-   * {@link #getPath()}).
+   * Execute an update action.
    * 
    * @param parameters
    *          the parameters often coming from the HTTP request
--- a/modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonDataService.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonDataService.java	Fri Feb 14 15:32:23 2014 +0100
@@ -37,7 +37,7 @@
   /**
    * Do a query for {@link BaseOBObject} objects and return the result as a json string.
    * 
-   * One parameter is mandatory: {@link JsonConstants.ENTITYNAME}. The possible query parameters can
+   * One parameter is mandatory: {@link JsonConstants#ENTITYNAME}. The possible query parameters can
    * be found in {@link JsonConstants}, see the constants ending with _PARAMETER. All other request
    * parameters which correspond to properties of the queried objects are considered to be filter
    * properties.
@@ -49,15 +49,15 @@
    * 
    * @param parameters
    *          the parameters driving the query, one parameter is mandatory:
-   *          {@link JsonConstants.ENTITYNAME}
+   *          {@link JsonConstants#ENTITYNAME}
    * @return a json result string
    * @see QueryBuilder
    */
   public abstract String fetch(Map<String, String> parameters);
 
   /**
-   * Remove an object, this method expects two parameters: {@link JsonConstants.ID} and
-   * {@link JsonConstants.ENTITYNAME}. If they are not present an error is returned.
+   * Remove an object, this method expects two parameters: {@link JsonConstants#ID} and
+   * {@link JsonConstants#ENTITYNAME}. If they are not present an error is returned.
    * 
    * @param parameters
    *          two parameters should be present: id and entityName
--- a/modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonToDataConverter.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/modules/org.openbravo.service.json/src/org/openbravo/service/json/JsonToDataConverter.java	Fri Feb 14 15:32:23 2014 +0100
@@ -616,8 +616,8 @@
 
   /**
    * Checks if the property is settable ({@link #isNotConvertable(BaseOBObject, Property)}. If so
-   * the jsonValue is converted ({@link #convertPrimitive(Property, Object)}, in case of a primive),
-   * or in case of a reference property the referenced object is read/created.
+   * the jsonValue is converted ({@link #convertJsonToPropertyValue(Property, Object)}, in case of a
+   * primitive), or in case of a reference property the referenced object is read/created.
    * 
    * @param obObject
    *          the object to set
@@ -753,7 +753,6 @@
    * @see Property#isAuditInfo()
    * @see Property#isClientOrOrganization()
    * @see Property#isOneToMany()
-   * @return
    */
   protected boolean isNotConvertable(BaseOBObject obObject, Property property) {
     // one-to-many are never json-ized
--- a/src/org/openbravo/authentication/AuthenticationManager.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/src/org/openbravo/authentication/AuthenticationManager.java	Fri Feb 14 15:32:23 2014 +0100
@@ -193,8 +193,8 @@
    * @param password
    *          Password to validate user
    * @return the value of AD_User_ID if the user is already authenticated or <b>null</b> if not
-   * @throws AuthenticationExceptionin
-   *           case of an authentication error different than incorrect user/password (which just
+   * @throws AuthenticationException
+   *           in case of an authentication error different than incorrect user/password (which just
    *           returns null)
    */
   public final String webServiceAuthenticate(String user, String password)
@@ -263,8 +263,8 @@
    * @param password
    *          Password to validate user
    * @return the value of AD_User_ID if the user is already authenticated or <b>null</b> if not
-   * @throws AuthenticationExceptionin
-   *           case of an authentication error different than incorrect user/password (which just
+   * @throws AuthenticationException
+   *           in case of an authentication error different than incorrect user/password (which just
    *           returns null)
    */
   public final String connectorAuthenticate(String user, String password)
--- a/src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java	Fri Feb 14 15:32:23 2014 +0100
@@ -124,7 +124,7 @@
    *          String with the productId.
    * @param attributeValues
    *          Map with the attribute values.
-   * @param Organization
+   * @param organization
    *          Organization for the attribute set instance.
    * @return OBError with the result.
    * @throws ServletException
--- a/src/org/openbravo/erpCommon/utility/ErrorTextParser.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/src/org/openbravo/erpCommon/utility/ErrorTextParser.java	Fri Feb 14 15:32:23 2014 +0100
@@ -166,7 +166,7 @@
    * Helper method to get a (slightly better) human-readable name for a database column based on its
    * name. Method uses AD_ELEMENT.name and AD_ELEMENT_TRL.NAME for this purpose
    * 
-   * @param tableName
+   * @param columnName
    *          name of a database column
    * @return translated, human-readable name
    */
--- a/src/org/openbravo/service/db/QueryTimeOutUtil.java	Fri Feb 14 13:32:00 2014 +0100
+++ b/src/org/openbravo/service/db/QueryTimeOutUtil.java	Fri Feb 14 15:32:23 2014 +0100
@@ -154,7 +154,6 @@
   /**
    * Sets a timeout for a sql statement, if possible
    * 
-   * @param criteria
    * @param type
    *          query type, it will be used to fetch the proper timeout
    */
@@ -184,8 +183,6 @@
 
   /**
    * Sets the 0 the timeout of a hibernate query
-   * 
-   * @param query
    */
   public static void resetQueryTimeOut(Query query) {
     query.setTimeout(0);
@@ -193,8 +190,6 @@
 
   /**
    * Sets the 0 the timeout of a hibernate criteria
-   * 
-   * @param query
    */
   public static void resetQueryTimeOut(Criteria criteria) {
     criteria.setTimeout(0);
@@ -202,8 +197,6 @@
 
   /**
    * Sets the 0 the timeout of a sql statement
-   * 
-   * @param query
    */
   public static void resetQueryTimeOut(Statement statement) {
     try {