details: https://code.openbravo.com/erp/devel/pi/rev/35c004afbdca
changeset: 26804:35c004afbdca
user: Stefan Hühner <stefan.huehner <at> openbravo.com>
date: Sat May 30 19:19:54 2015 +0200
summary: Fixed 30050: cleanup javadoc warnings
This commit clean up all javadoc warnings as shown by eclipse or
ant generate.java.doc
Exception are 3 warnings inside CSSMinimizer.java which is external code
and will should be fixed differently (upstream)
Most fixes are:
- Deleting useless java doc tags (useless as not documenting anything)
- Fixing up paramater references and link target
diffstat:
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/ad_actionbutton/AddOrderOrInvoice.java
| 5 +-
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/hqlinjections/AddPaymentOrderInvoicesTransformer.java
| 22 ----------
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java
| 5 +-
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_PaymentMonitorProcess.java
| 3 -
modules/org.openbravo.client.application/src/org/openbravo/client/application/DynamicExpressionParser.java
| 2 +-
modules/org.openbravo.client.application/src/org/openbravo/client/application/event/ReorderCascadingChildDeletionsHandler.java
| 3 +-
modules/org.openbravo.client.myob/src/org/openbravo/client/myob/MyOBUtils.java
| 6 +-
modules/org.openbravo.client.querylist/src/org/openbravo/client/querylist/QueryListDataSource.java
| 4 +-
modules/org.openbravo.financial.paymentreport/src/org/openbravo/financial/paymentreport/erpCommon/ad_reports/PaymentReportDao.java
| 22 ----------
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/ADTreeDatasourceService.java
| 11 -----
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/HQLDataSourceService.java
| 6 --
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/LinkToParentTreeDatasourceService.java
| 5 --
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/TreeDatasourceService.java
| 6 +--
modules/org.openbravo.userinterface.selector/src/org/openbravo/userinterface/selector/CustomQuerySelectorDatasource.java
| 3 +-
src/org/openbravo/base/secureApp/HttpSecureAppServlet.java
| 2 +-
src/org/openbravo/base/secureApp/LoginUtils.java
| 5 +-
src/org/openbravo/base/secureApp/OrgTree.java
| 9 ----
src/org/openbravo/base/session/HostNameTask.java
| 2 +-
src/org/openbravo/configuration/ConfigureOption.java
| 2 -
src/org/openbravo/costing/CostAdjustmentProcess.java
| 3 +-
src/org/openbravo/erpCommon/ad_forms/About.java
| 2 -
src/org/openbravo/erpCommon/ad_forms/AcctServer.java
| 4 +-
src/org/openbravo/erpCommon/ad_forms/ModuleManagement.java
| 11 -----
src/org/openbravo/erpCommon/ad_forms/Registration.java
| 10 ----
src/org/openbravo/erpCommon/ad_process/HeartbeatProcess.java
| 2 -
src/org/openbravo/erpCommon/ad_process/assets/AssetLinearDepreciationMethodProcess.java
| 2 +-
src/org/openbravo/erpCommon/businessUtility/AuditTrailDeletedRecords.java
| 2 +-
src/org/openbravo/erpCommon/businessUtility/COAUtility.java
| 1 -
src/org/openbravo/erpCommon/modules/ImportModule.java
| 7 ---
src/org/openbravo/erpCommon/modules/ModuleTree.java
| 3 -
src/org/openbravo/erpCommon/modules/ModuleUtiltiy.java
| 2 -
src/org/openbravo/erpCommon/obps/ActivationKey.java
| 3 -
src/org/openbravo/erpCommon/utility/ComboTableData.java
| 2 -
src/org/openbravo/erpCommon/utility/UsedByLink.java
| 2 -
src/org/openbravo/erpCommon/utility/Utility.java
| 3 -
src/org/openbravo/erpCommon/utility/poc/EmailManager.java
| 4 +-
src/org/openbravo/erpCommon/utility/reporting/printing/PrintController.java
| 6 --
src/org/openbravo/scheduling/OBScheduler.java
| 6 --
38 files changed, 24 insertions(+), 174 deletions(-)
diffs (truncated from 797 to 300 lines):
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/ad_actionbutton/AddOrderOrInvoice.java
---
a/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/ad_actionbutton/AddOrderOrInvoice.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/ad_actionbutton/AddOrderOrInvoice.java
Sat May 30 19:19:54 2015 +0200
@@ -833,8 +833,8 @@
*
* @param vars
* VariablseSecureApp with the session data.
- * @param selectedPaymentScheduleDetails
- * List of FIN_PaymentScheduleDetails that need to be included in
the HashMap.
+ * @param _strSelectedScheduledPaymentDetailIds
+ * List of id's of FIN_PaymentScheduleDetails that need to be
included in the HashMap.
* @return A HashMap mapping the FIN_PaymentScheduleDetail's Id with the
corresponding amount.
*/
private HashMap<String, BigDecimal>
getSelectedPaymentDetailsAndAmount(VariablesSecureApp vars,
@@ -876,7 +876,6 @@
* : amount to split among the set
* @param psdSet
* : set of payment schedule details where to allocate the amount
- * @return
*/
private HashMap<String, BigDecimal> calculateAmounts(BigDecimal
recordAmount, Set<String> psdSet) {
BigDecimal remainingAmount = recordAmount;
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/hqlinjections/AddPaymentOrderInvoicesTransformer.java
---
a/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/hqlinjections/AddPaymentOrderInvoicesTransformer.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/hqlinjections/AddPaymentOrderInvoicesTransformer.java
Sat May 30 19:19:54 2015 +0200
@@ -329,10 +329,6 @@
/**
* Order by selectedPSDs, scheduled date and document number
- *
- * @param selectedPSDs
- * @param transactionType
- * @return
*/
protected StringBuffer getOrderByClause(String transactionType, List<String>
selectedPSDs,
Map<String, String> requestParameters) {
@@ -391,13 +387,6 @@
return hqlQuery;
}
- /**
- * @param _hqlQuery
- * @param transactionType
- * @param criteria
- * @param queryNamedParameters
- * @return
- */
protected String calculateHavingClause(String _hqlQuery, String
transactionType,
JSONObject criteria, Map<String, Object> queryNamedParameters) {
String hqlQuery = _hqlQuery;
@@ -527,13 +516,6 @@
return hqlQuery;
}
- /**
- * @param _hqlQuery
- * @param transactionType
- * @param selectedPSDs
- * @param orderByClause
- * @return
- */
protected String appendOrderByClause(String _hqlQuery, StringBuffer
orderByClause,
boolean justCount) {
String hqlQuery = _hqlQuery;
@@ -570,10 +552,6 @@
buildCriteria.put("criteria", newCriteriaArray);
}
- /**
- * @param expression
- * @return
- */
protected String getAggregatorFunction(String expression) {
return " hqlagg(" + expression + ")";
}
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java
---
a/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_AddPayment.java
Sat May 30 19:19:54 2015 +0200
@@ -1276,9 +1276,6 @@
/**
* Returns the date in which last payment for this invoice took place
- *
- * @param invoice
- * @return
*/
private static Date getFinalSettlementDate(Invoice invoice) {
final OBCriteria<FIN_PaymentSchedInvV> obc =
OBDal.getInstance().createCriteria(
@@ -1526,7 +1523,7 @@
* Payment Schedule Detail amount.
* @param paymentAmount
* Amount selected to be collected. Always less or equal than
scheduleDetailAmount.
- * @param doubtfulDebtAmount
+ * @param doubtfulDebtTotalAmount
* Payment Schedule Detail doubtFulDebt amount.
* @return resultant doubtful debt amount. Zero if no doubtful debt amount
was present.
*/
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_PaymentMonitorProcess.java
---
a/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_PaymentMonitorProcess.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.advpaymentmngt/src/org/openbravo/advpaymentmngt/process/FIN_PaymentMonitorProcess.java
Sat May 30 19:19:54 2015 +0200
@@ -191,9 +191,6 @@
/**
* Returns the date in which last payment for this invoice took place
- *
- * @param invoice
- * @return
*/
private static Date getFinalSettlementDate(Invoice invoice) {
final OBCriteria<FIN_PaymentSchedInvV> obc =
OBDal.getInstance().createCriteria(
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.client.application/src/org/openbravo/client/application/DynamicExpressionParser.java
---
a/modules/org.openbravo.client.application/src/org/openbravo/client/application/DynamicExpressionParser.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.client.application/src/org/openbravo/client/application/DynamicExpressionParser.java
Sat May 30 19:19:54 2015 +0200
@@ -262,7 +262,7 @@
*
* If the value is enclosed between brackets, it is extracted, translated
and enclosed again
*
- * @see DynamicExpressionParserTest
+ * There is a junit test in the class: DynamicExpressionParserTest
*
* @param value
* A string expression like <b>'Y'</b>
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.client.application/src/org/openbravo/client/application/event/ReorderCascadingChildDeletionsHandler.java
---
a/modules/org.openbravo.client.application/src/org/openbravo/client/application/event/ReorderCascadingChildDeletionsHandler.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.client.application/src/org/openbravo/client/application/event/ReorderCascadingChildDeletionsHandler.java
Sat May 30 19:19:54 2015 +0200
@@ -45,7 +45,8 @@
* following deletion fails as the record is not longer present. This class
works around that by
* explicitely deleting c_ordertax entries on delete of c_order. (Same for
c_invoicetax)
*
- * @link https://issues.openbravo.com/view.php?id=17199
+ * {@link "https://issues.openbravo.com/view.php?id=17199"}
+ *
* @author shuehner
*/
public class ReorderCascadingChildDeletionsHandler extends
EntityPersistenceEventObserver {
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.client.myob/src/org/openbravo/client/myob/MyOBUtils.java
---
a/modules/org.openbravo.client.myob/src/org/openbravo/client/myob/MyOBUtils.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.client.myob/src/org/openbravo/client/myob/MyOBUtils.java
Sat May 30 19:19:54 2015 +0200
@@ -68,12 +68,12 @@
* Computes the widget title using the user's language, if no translation is
available then the
* {@link WidgetClass#getWidgetTitle()} is used.
*
- * @param widgetInstance
+ * @param widgetClass
* the widget class of this instance is used to read the title
* @return the title of the widget read from the widgetclass
- * @see WidgetInstance#getOBKMOWidgetClass()
+ * @see WidgetInstance#getWidgetClass()
* @see WidgetClassTrl
- * @see WidgetClass#getTitle()
+ * @see WidgetClass#getWidgetTitle()
*/
static String getWidgetTitle(WidgetClass widgetClass) {
final String userLanguageId =
OBContext.getOBContext().getLanguage().getId();
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.client.querylist/src/org/openbravo/client/querylist/QueryListDataSource.java
---
a/modules/org.openbravo.client.querylist/src/org/openbravo/client/querylist/QueryListDataSource.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.client.querylist/src/org/openbravo/client/querylist/QueryListDataSource.java
Sat May 30 19:19:54 2015 +0200
@@ -318,9 +318,9 @@
* fields. If the HQL query already contains order by fields, the new fields
are appended for the
* existing fields.
*
- * @param hQL
+ * @param hql
* original HQL query
- * @param sortByParametersString
+ * @param sortBy
* parameter that contains sortBy field values
* @return an updated HQL query that will set the order by fields
*/
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.financial.paymentreport/src/org/openbravo/financial/paymentreport/erpCommon/ad_reports/PaymentReportDao.java
---
a/modules/org.openbravo.financial.paymentreport/src/org/openbravo/financial/paymentreport/erpCommon/ad_reports/PaymentReportDao.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.financial.paymentreport/src/org/openbravo/financial/paymentreport/erpCommon/ad_reports/PaymentReportDao.java
Sat May 30 19:19:54 2015 +0200
@@ -1199,9 +1199,6 @@
* This method combines the information from the transactions list and the
last element inserted
* into grouped data into total data.
*
- * @param fieldProvider
- * @param transactionsList
- * @param totalData
* @throws OBException
*/
private boolean insertIntoTotal(FieldProvider data,
@@ -1223,8 +1220,6 @@
/**
* This method creates a field provider with the information of the
transaction
*
- * @param fin_FinaccTransaction
- * @return
* @throws OBException
*/
private FieldProvider
createFieldProviderForTransaction(FIN_FinaccTransaction transaction,
@@ -1471,11 +1466,6 @@
/**
* This method compares the status and the order criteria of the
transactions and data
- *
- * @param transaction
- * @param data
- * @param strOrdCrit
- * @return
*/
private boolean isBeforeStatusAndOrder(FIN_FinaccTransaction transaction,
FieldProvider data,
String strOrdCrit, String BPName, String BPCategory, String strProject) {
@@ -1495,11 +1485,6 @@
/**
* This method compares recursively the order criteria of the transactions
and data
- *
- * @param transaction
- * @param data
- * @param strOrdCrit
- * @return
*/
private boolean isBeforeOrder(FIN_FinaccTransaction transaction,
FieldProvider data,
String[] strOrdCritList, int i, String BPName, String BPCategory, String
strProject) {
@@ -1646,10 +1631,6 @@
/**
* Compares two DIFFERENT payment status. If the first one goes before the
second it returns true,
* elsewise it returns false
- *
- * @param firstValue
- * @param secondValue
- * @return
*/
private boolean isBeforeStatus(String firstValue, String secondValue) {
String[] strStatus = { firstValue, secondValue };
@@ -2209,9 +2190,6 @@
/**
* Given a String of organizations this method returns an array of
organizations
- *
- * @param strOrgFamily
- * @return
*/
private Organization[] getOrganizations(Set<String> strOrgFamily) {
Iterator<String> orgChildTreeIter = strOrgFamily.iterator();
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/ADTreeDatasourceService.java
---
a/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/ADTreeDatasourceService.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/ADTreeDatasourceService.java
Sat May 30 19:19:54 2015 +0200
@@ -485,9 +485,6 @@
/**
* Checks if a tree is ordered
- *
- * @param tree
- * @return
*/
private boolean isOrdered(Tree tree) {
Table table = tree.getTable();
@@ -502,10 +499,6 @@
/**
* Returns a Tree given the referencedTableId and the parentRecordId
- *
- * @param referencedTableId
- * @param parentRecordId
- * @return
*/
private Tree getTree(String referencedTableId) {
Table referencedTable = OBDal.getInstance().get(Table.class,
referencedTableId);
@@ -522,10 +515,6 @@
* Returns a Tree given the referencedTableId and a jsonobject that contains
the node properties
* This is called from the EventHandler, because the parentRecordId is not
avaiable in the
* parameters
- *
- * @param referencedTableId
- * @param parentRecordId
- * @return
*/
private Tree getTree(Table table, JSONObject bobProperties) {
Tree tree = null;
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/HQLDataSourceService.java
---
a/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/HQLDataSourceService.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/HQLDataSourceService.java
Sat May 30 19:19:54 2015 +0200
@@ -231,11 +231,6 @@
* Returns a hibernate query object based on the hql query, if the justCount
parameter is true,
* the query will just return the number of records that fulfill the
criteria. If justCount is
* false, the query will return all the actual records that fulfill the
criteria
- *
- * @param table
- * @param parameters
- * @param justCount
- * @return
*/
private Query getQuery(Table table, Map<String, String> parameters, boolean
justCount) {
OBContext.setAdminMode(true);
@@ -561,7 +556,6 @@
* filter created from the grid criteria
* @param parameters
* parameters used for this request
- * @return
*/
private String addAdditionalFilters(Table table, String hqlQuery, String
filterWhereClause,
Map<String, String> parameters) {
diff -r 85e792e6b36a -r 35c004afbdca
modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/LinkToParentTreeDatasourceService.java
---
a/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/LinkToParentTreeDatasourceService.java
Fri May 29 15:21:50 2015 +0000
+++
b/modules/org.openbravo.service.datasource/src/org/openbravo/service/datasource/LinkToParentTreeDatasourceService.java
Sat May 30 19:19:54 2015 +0200
@@ -187,7 +187,6 @@
* hql where clase of the tab/selector
* @param hqlWhereClauseRootNodes
------------------------------------------------------------------------------
_______________________________________________
Openbravo-commits mailing list
Openbravo-commits@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openbravo-commits
