details: https://code.openbravo.com/erp/devel/pi/rev/b397d543dff6
changeset: 20169:b397d543dff6
user: Stefan Hühner <stefan.huehner <at> openbravo.com>
date: Mon Apr 22 14:09:34 2013 +0200
summary: Fixed 23604: Fixup javadoc syntax errors
Fixing lots of javadoc errors, most following up parameter renaming.
diffstat:
src/org/openbravo/costing/CostingUtils.java | 16
+++++-----
src/org/openbravo/dal/security/OrganizationStructureProvider.java | 5 +-
src/org/openbravo/erpCommon/ad_forms/AcctServer.java | 4 +-
src/org/openbravo/erpCommon/businessUtility/AccountTree.java | 6 +-
src/org/openbravo/erpCommon/modules/VersionUtility.java | 7 +++-
src/org/openbravo/erpCommon/obps/ActivationKey.java | 2 -
src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java | 2 -
src/org/openbravo/erpCommon/utility/OBDateUtils.java | 6 +--
src/org/openbravo/erpCommon/utility/OBMessageUtils.java | 8 +---
src/org/openbravo/erpCommon/utility/TreeUtility.java | 13
--------
src/org/openbravo/erpCommon/utility/Utility.java | 4 +-
src/org/openbravo/erpCommon/utility/poc/EmailManager.java | 8 +++-
src/org/openbravo/financial/FinancialUtils.java | 2 +-
src/org/openbravo/service/db/CallStoredProcedure.java | 11 ++++--
14 files changed, 39 insertions(+), 55 deletions(-)
diffs (truncated from 342 to 300 lines):
diff -r 8b85b058240c -r b397d543dff6 src/org/openbravo/costing/CostingUtils.java
--- a/src/org/openbravo/costing/CostingUtils.java Mon Apr 22 16:58:39
2013 +0530
+++ b/src/org/openbravo/costing/CostingUtils.java Mon Apr 22 14:09:34
2013 +0200
@@ -56,8 +56,8 @@
protected static Logger log4j = Logger.getLogger(CostingUtils.class);
/**
- * Calls {@link #getTransactionCost(MaterialTransaction, Date, boolean)}
setting the calculateTrx
- * flag to false.
+ * Calls {@link #getTransactionCost(MaterialTransaction, Date, boolean,
Currency)} setting the
+ * calculateTrx flag to false.
*/
public static BigDecimal getTransactionCost(MaterialTransaction transaction,
Date date,
Currency currency) {
@@ -104,8 +104,8 @@
}
/**
- * Calls {@link #getStandardCost(Product, Date, HashMap, boolean)} setting
the
- * recheckWithoutDimensions flag to true.
+ * Calls {@link #getStandardCost(Product, Organization, Date, HashMap,
boolean, Currency)} setting
+ * the recheckWithoutDimensions flag to true.
*/
public static BigDecimal getStandardCost(Product product, Organization org,
Date date,
HashMap<CostDimension, BaseOBObject> costDimensions, Currency
convCurrency)
@@ -144,8 +144,8 @@
}
/**
- * Calls {@link #hasStandardCostDefinition(Product, Date, HashMap, boolean)}
setting the
- * recheckWithoutDimensions flag to true.
+ * Calls {@link #hasStandardCostDefinition(Product, Organization, Date,
HashMap, boolean)} setting
+ * the recheckWithoutDimensions flag to true.
*/
public static boolean hasStandardCostDefinition(Product product,
Organization org, Date date,
HashMap<CostDimension, BaseOBObject> costDimensions) {
@@ -173,8 +173,8 @@
}
/**
- * Calls {@link #getStandardCostDefinition(Product, Date, HashMap, boolean)}
setting the
- * recheckWithoutDimensions flag to true.
+ * Calls {@link #getStandardCostDefinition(Product, Organization, Date,
HashMap, boolean)} setting
+ * the recheckWithoutDimensions flag to true.
*/
public static Costing getStandardCostDefinition(Product product,
Organization org, Date date,
HashMap<CostDimension, BaseOBObject> costDimensions) {
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/dal/security/OrganizationStructureProvider.java
--- a/src/org/openbravo/dal/security/OrganizationStructureProvider.java Mon Apr
22 16:58:39 2013 +0530
+++ b/src/org/openbravo/dal/security/OrganizationStructureProvider.java Mon Apr
22 14:09:34 2013 +0200
@@ -234,8 +234,8 @@
/**
* Returns the parent organization of an organization.
*
- * @param orgId
- * the id of the organization for which the parent organization is
determined.
+ * @param org
+ * the organization for which the parent organization is determined.
* @return the parent organization.
*/
public Organization getParentOrg(Organization org) {
@@ -456,7 +456,6 @@
*
* @param org
* Organization to get its period control allowed organization.
- * @return
*/
public Organization getPeriodControlAllowedOrganization(final Organization
org) {
if (org.isAllowPeriodControl()) {
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/ad_forms/AcctServer.java
--- a/src/org/openbravo/erpCommon/ad_forms/AcctServer.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/ad_forms/AcctServer.java Mon Apr 22
14:09:34 2013 +0200
@@ -1859,8 +1859,6 @@
*
* @param BPartnerId
* : ID of the Business Partner
- * @param isExpense
- * : Provision Expense Account. If not it applies to Provision
Applied account
* @param as
* : Accounting Schema
* @param conn
@@ -1903,7 +1901,7 @@
throw new IllegalStateException();
}
return new Account(conn, strValidCombination);
- } // getAccountBPartnerBadDebt
+ }
/**
* Get the account for GL Item
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/businessUtility/AccountTree.java
--- a/src/org/openbravo/erpCommon/businessUtility/AccountTree.java Mon Apr
22 16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/businessUtility/AccountTree.java Mon Apr
22 14:09:34 2013 +0200
@@ -56,11 +56,11 @@
* VariablesSecureApp object with the session methods.
* @param _conn
* ConnectionProvider object with the connection methods.
- * @param _elements
+ * @param _accountsTree
* Array of element values. (structure)
- * @param _accounts
+ * @param _accountsFacts
* Array of accounting facts. (data)
- * @param _elementValueParent
+ * @param _reportNode
* String with the value of the parent element to evaluate.
* @throws ServletException
*/
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/modules/VersionUtility.java
--- a/src/org/openbravo/erpCommon/modules/VersionUtility.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/modules/VersionUtility.java Mon Apr 22
14:09:34 2013 +0200
@@ -507,8 +507,11 @@
/**
* Compares 2 versions taking into account just their major versions.
*
- * @return<ul> <li>-1 in case ver1 is lower than ver2 <li>0 in case ver1
equals ver2 <li>1 in case
- * ver1 is higher than ver2 </ul>
+ * @return <ul>
+ * <li>-1 in case ver1 is lower than ver2
+ * <li>0 in case ver1 equals ver2
+ * <li>1 in case ver1 is higher than ver2
+ * </ul>
*/
static public int versionCompareStrictMajorVersion(String ver1, String ver2)
{
if ((ver1 == null || ver1.equals("")) && (ver2 == null || ver2.equals("")))
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/obps/ActivationKey.java
--- a/src/org/openbravo/erpCommon/obps/ActivationKey.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/obps/ActivationKey.java Mon Apr 22
14:09:34 2013 +0200
@@ -927,8 +927,6 @@
/**
* Checks if heartbeat is active and a beat has been sent during last days.
- *
- * @return
*/
public boolean isHeartbeatActive() {
OBContext.setAdminMode();
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java
--- a/src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java
Mon Apr 22 16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/AttributeSetInstanceValue.java
Mon Apr 22 14:09:34 2013 +0200
@@ -110,8 +110,6 @@
* Handler for the database connection.
* @param vars
* Handler for the session info.
- * @param data
- * AttributeSetInstanceValueData with the attribute set info.
* @param strAttributeSet
* String with the record attributeSetId.
* @param strInstance
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/OBDateUtils.java
--- a/src/org/openbravo/erpCommon/utility/OBDateUtils.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/OBDateUtils.java Mon Apr 22
14:09:34 2013 +0200
@@ -41,8 +41,6 @@
*
* @param date
* Date to be formatted.
- * @param pattern
- * Format expected for the output.
* @return String formatted.
*/
public static String formatDate(Date date) {
@@ -113,9 +111,9 @@
/**
* Determines the labor days between two dates
*
- * @param strDate1
+ * @param _strDate1
* Date 1.
- * @param strDate2
+ * @param _strDate2
* Date 2.
* @param dateFormatter
* Format of the dates.
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/OBMessageUtils.java
--- a/src/org/openbravo/erpCommon/utility/OBMessageUtils.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/OBMessageUtils.java Mon Apr 22
14:09:34 2013 +0200
@@ -20,8 +20,6 @@
import java.util.Map;
-import javax.servlet.ServletException;
-
import org.apache.log4j.Logger;
import org.hibernate.criterion.Restrictions;
import org.openbravo.base.exception.OBException;
@@ -169,7 +167,7 @@
*
* @param text
* String with the text to translate.
- * @param replaceMap
+ * @param map
* optional Map containing replacement values for the tokens
* @return String translated.
*/
@@ -283,7 +281,6 @@
* @param pInstance
* ProcessInstance object
* @return Object with the message.
- * @throws ServletException
*/
public static OBError getProcessInstanceMessage(ProcessInstance pInstance) {
OBError myMessage = new OBError();
@@ -334,7 +331,6 @@
*
* @param message
* String with the message to translate.
- * @return
*/
public static OBError translateError(String message) {
VariablesSecureApp vars = RequestContext.get().getVariablesSecureApp();
@@ -352,7 +348,7 @@
* Handler for the session info.
* @param strLanguage
* Language to translate.
- * @param message
+ * @param _message
* String with the message to translate.
* @return Object with the message.
*/
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/TreeUtility.java
--- a/src/org/openbravo/erpCommon/utility/TreeUtility.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/TreeUtility.java Mon Apr 22
14:09:34 2013 +0200
@@ -40,10 +40,6 @@
/**
* Gets Natural tree for the given node
- *
- * @param nodeId
- * @param treeType
- * @return
*/
public Set<String> getNaturalTree(String nodeId, String treeType) {
initialize(treeType);
@@ -60,11 +56,6 @@
/**
* Gets the Child tree for the given node, including optionally given node
- *
- * @param nodeId
- * @param treeType
- * @param includeNode
- * @return
*/
public Set<String> getChildTree(String nodeId, String treeType, boolean
includeNode) {
initialize(treeType);
@@ -86,10 +77,6 @@
/**
* Gets Child node in the tree
- *
- * @param nodeId
- * @param treeType
- * @return
*/
public Set<String> getChildNode(String nodeId, String treeType) {
initialize(treeType);
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/Utility.java
--- a/src/org/openbravo/erpCommon/utility/Utility.java Mon Apr 22 16:58:39
2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/Utility.java Mon Apr 22 14:09:34
2013 +0200
@@ -81,6 +81,7 @@
import org.openbravo.erpCommon.obps.ActivationKey;
import org.openbravo.erpCommon.obps.ActivationKey.LicenseClass;
import org.openbravo.erpCommon.reference.PInstanceProcessData;
+import org.openbravo.model.ad.process.ProcessInstance;
import org.openbravo.model.ad.system.ClientInformation;
import org.openbravo.model.ad.system.SystemInformation;
import org.openbravo.model.ad.ui.Process;
@@ -1261,8 +1262,7 @@
}
/**
- * @see OBMessageUtils#getProcessInstanceMessage(ConnectionProvider,
VariablesSecureApp,
- * PInstanceProcessData[])
+ * @see OBMessageUtils#getProcessInstanceMessage(ProcessInstance)
*/
public static OBError getProcessInstanceMessage(ConnectionProvider conn,
VariablesSecureApp vars,
PInstanceProcessData[] pinstanceData) throws ServletException {
diff -r 8b85b058240c -r b397d543dff6
src/org/openbravo/erpCommon/utility/poc/EmailManager.java
--- a/src/org/openbravo/erpCommon/utility/poc/EmailManager.java Mon Apr 22
16:58:39 2013 +0530
+++ b/src/org/openbravo/erpCommon/utility/poc/EmailManager.java Mon Apr 22
14:09:34 2013 +0200
@@ -188,7 +188,9 @@
}
/**
- * Since Openbravo 3.0MP9 only {@link #sendEmail()} is used for the full
email sending cycle
+ * Since Openbravo 3.0MP9 only
+ * {@link #sendEmail(String, boolean, String, String, String, int, String,
String, String, String, String, String, String, String, List, Date, List)}
+ * is used for the full email sending cycle
*/
@Deprecated
public static Session newMailSession(ConnectionProvider connectionProvider,
String clientId,
@@ -244,7 +246,9 @@
}
/**
- * Since Openbravo 3.0MP9 only {@link #sendEmail()} is used for the full
email sending cycle
+ * Since Openbravo 3.0MP9 only
+ * {@link #sendEmail(String, boolean, String, String, String, int, String,
String, String, String, String, String, String, String, List, Date, List)}
+ * is used for the full email sending cycle
*/
------------------------------------------------------------------------------
Precog is a next-generation analytics platform capable of advanced
analytics on semi-structured data. The platform includes APIs for building
apps and a phenomenal toolset for data science. Developers can use
our toolset for easy data analysis & visualization. Get a free account!
http://www2.precog.com/precogplatform/slashdotnewsletter
_______________________________________________
Openbravo-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openbravo-commits
