Improved: refactor javadocs in OFBiz to be standards compliant
(OFBIZ-9144)
git-svn-id: https://svn.apache.org/repos/asf/ofbiz/trunk@1774922 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java
index a08d5f4..0c4c888 100644
--- a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java
+++ b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/invoice/InvoiceWorker.java
@@ -369,7 +369,7 @@
return InvoiceWorker.getInvoiceTotal(invoice, actualCurrency).subtract(getInvoiceApplied(invoice, actualCurrency));
}
/**
- * Returns amount not applied (i.e., still outstanding) of an invoice at an asOfDate, based on Payment.effectiveDate <= asOfDateTime
+ * Returns amount not applied (i.e., still outstanding) of an invoice at an asOfDate, based on Payment.effectiveDate <= asOfDateTime
*
* @param invoice GenericValue object of the invoice
* @param asOfDateTime the date to use
@@ -391,7 +391,7 @@
}
/**
- * Returns amount applied to invoice before an asOfDateTime, based on Payment.effectiveDate <= asOfDateTime
+ * Returns amount applied to invoice before an asOfDateTime, based on Payment.effectiveDate <= asOfDateTime
*
* @param delegator the delegator
* @param invoiceId the invoice id
diff --git a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java
index 73feb60..8fdd68f 100644
--- a/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java
+++ b/applications/accounting/src/main/java/org/apache/ofbiz/accounting/payment/PaymentGatewayServices.java
@@ -3333,7 +3333,7 @@
/**
- * Simple test processor; declines all orders < 100.00; approves all orders >= 100.00
+ * Simple test processor; declines all orders < 100.00; approves all orders >= 100.00
*/
public static Map<String, Object> testProcessor(DispatchContext dctx, Map<String, ? extends Object> context) {
Locale locale = (Locale) context.get("locale");
@@ -3363,7 +3363,7 @@
/**
- * Simple test processor; declines all orders < 100.00; approves all orders > 100.00
+ * Simple test processor; declines all orders < 100.00; approves all orders > 100.00
*/
public static Map<String, Object> testProcessorWithCapture(DispatchContext dctx, Map<String, ? extends Object> context) {
Locale locale = (Locale) context.get("locale");
diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java
index 481a239..741c27c 100644
--- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java
+++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRun.java
@@ -113,11 +113,13 @@
return productionRun;
}
/**
- * store the modified ProductionRun object in the database.
- * <li>store the the productionRun header
- * <li> the productProduced related data
- * <li> the listRoutingTask related data
- * <li> the productComponent list related data
+ * Store the modified ProductionRun object in the database.
+ * <ul>
+ * <li>store the the productionRun header</li>
+ * <li> the productProduced related data</li>
+ * <li> the listRoutingTask related data</li>
+ * <li> the productComponent list related data</li>
+ * </ul>
* @return true if success false otherwise
**/
public boolean store() {
@@ -245,10 +247,10 @@
this.estimatedCompletionDate = estimatedCompletionDate;
}
/**
- * recalculated the estimatedCompletionDate property.
- * Use the quantity and the estimatedStartDate properties as entries parameters.
- * <br/>read the listRoutingTask and for each recalculated and update the estimatedStart and endDate in the object.
- * <br/> no store in the database is done.
+ * Recalculate the estimatedCompletionDate property.
+ * Use the quantity and the estimatedStartDate properties as entries parameters.
+ * Read the listRoutingTask and for each recalculated and update the estimatedStart and endDate in the object.
+ * No store in the database is done.
* @param priority give the routingTask start point to recalculated
* @return the estimatedCompletionDate calculated
**/
diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java
index a5d995e..33c1513 100644
--- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java
+++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunHelper.java
@@ -45,12 +45,11 @@
/**
* Get a Production Run.
- * <li> check if routing - product link exist
+ * Check if routing - product link exists.
+ *
* @param delegator the delegator
* @param productionRunId the production run id
* @return Map with the result of the service, the output parameters are
- * <li> the productionRun
- * <li> the productionRunProduct
*/
public static Map<String, Object> getProductionRun(Delegator delegator, String productionRunId) {
Map<String, Object> result = new HashMap<String, Object>();
diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java
index db636bb..d2f01c1 100644
--- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java
+++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/jobshopmgt/ProductionRunServices.java
@@ -174,14 +174,16 @@
/**
* Creates a Production Run.
- * <li> check if routing - product link exist
- * <li> check if product have a Bill Of Material
- * <li> check if routing have routingTask
- * <li> create the workEffort for ProductionRun
- * <li> create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce
- * <li> for each valid routingTask of the routing create a workeffort-task
- * <li> for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard
- * <li> for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard
+ * <ul>
+ * <li> check if routing - product link exist</li>
+ * <li> check if product have a Bill Of Material</li>
+ * <li> check if routing have routingTask</li>
+ * <li> create the workEffort for ProductionRun</li>
+ * <li> create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce</li>
+ * <li> for each valid routingTask of the routing create a workeffort-task</li>
+ * <li> for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard</li>
+ * <li> for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard</li>
+ * </ul>
* @param ctx The DispatchContext that this service is operating in.
* @param context Map containing the input parameters, productId, routingId, pRQuantity, startDate, workEffortName, description
* @return Map with the result of the service, the output parameters.
@@ -481,11 +483,13 @@
/**
* Update a Production Run.
- * <li> update field and after recalculate the entire ProductionRun data (routingTask and productComponent)
- * <li> create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce
- * <li> for each valid routingTask of the routing create a workeffort-task
- * <li> for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard
- * <li> for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard
+ * <ul>
+ * <li> update field and after recalculate the entire ProductionRun data (routingTask and productComponent)</li>
+ * <li> create the WorkEffortGoodStandard for link between ProductionRun and the product it will produce</li>
+ * <li> for each valid routingTask of the routing create a workeffort-task</li>
+ * <li> for the first routingTask, create for all the valid productIdTo with no associateRoutingTask a WorkEffortGoodStandard</li>
+ * <li> for each valid routingTask of the routing and valid productIdTo associate with this RoutingTask create a WorkEffortGoodStandard</li>
+ * </ul>
* @param ctx The DispatchContext that this service is operating in.
* @param context Map containing the input parameters, productId, routingId, quantity, estimatedStartDate, workEffortName, description
* @return Map with the result of the service, the output parameters.
@@ -1198,12 +1202,14 @@
}
/**
- * check if field for routingTask update are correct and if need recalculated data in Production Run.
- * Check<ul>
- * <li> if estimatedStartDate is not before Production Run estimatedStartDate.</ul>
- * <li> if there is not a another routingTask with the same priority
- * If priority or estimatedStartDate has changed recalculated data for routingTask after that one.
- * <br/> update the productionRun
+ * Check if field for routingTask update are correct and if need recalculated data in Production Run.
+ * Check
+ * <ul>
+ * <li> if estimatedStartDate is not before Production Run estimatedStartDate.</li>
+ * <li> if there is not a another routingTask with the same priority</li>
+ * <li>If priority or estimatedStartDate has changed recalculated data for routingTask after that one.</li>
+ * </ul>
+ * Update the productionRun
* @param ctx The DispatchContext that this service is operating in.
* @param context Map containing the input parameters, productId, routingId, priority, estimatedStartDate, estimatedSetupMillis, estimatedMilliSeconds
* @return Map with the result of the service, the output parameters, estimatedCompletionDate.
diff --git a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java
index 16ebd18..14a3972 100644
--- a/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java
+++ b/applications/manufacturing/src/main/java/org/apache/ofbiz/manufacturing/techdata/TechDataServices.java
@@ -59,7 +59,7 @@
*
* @param ctx the dispatch context
* @param context a map containing workEffortName (routingTaskName) and fixedAssetId (MachineGroup or ANY)
- * @return result a map containing lookupResult (list of RoutingTask <=> workEffortId with currentStatusId = "ROU_ACTIVE" and workEffortTypeId = "ROU_TASK"
+ * @return result a map containing lookupResult (list of RoutingTask <=> workEffortId with currentStatusId = "ROU_ACTIVE" and workEffortTypeId = "ROU_TASK"
*/
public static Map<String, Object> lookupRoutingTask(DispatchContext ctx, Map<String, ? extends Object> context) {
Delegator delegator = ctx.getDelegator();
diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java
index 6d5816c..dca7581 100644
--- a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java
+++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/SqlJdbcUtil.java
@@ -280,7 +280,7 @@
return sql.toString();
}
- /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
+ /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
@Deprecated
public static String makeWhereStringFromFields(List<ModelField> modelFields, Map<String, Object> fields, String operator) {
return makeWhereStringFromFields(new StringBuilder(), modelFields, fields, operator, null).toString();
@@ -290,13 +290,13 @@
return makeWhereStringFromFields(sb, modelFields, fields, operator, null);
}
- /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
+ /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
@Deprecated
public static String makeWhereStringFromFields(List<ModelField> modelFields, Map<String, Object> fields, String operator, List<EntityConditionParam> entityConditionParams) {
return makeWhereStringFromFields(new StringBuilder(), modelFields, fields, operator, entityConditionParams).toString();
}
- /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
+ /** Makes a WHERE clause String with "<col name>=?" if not null or "<col name> IS null" if null, all AND separated */
public static StringBuilder makeWhereStringFromFields(StringBuilder sb, List<ModelField> modelFields, Map<String, Object> fields, String operator, List<EntityConditionParam> entityConditionParams) {
if (modelFields.size() < 1) {
return sb;
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java
index 5c4cfe5..01ba25b 100644
--- a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java
+++ b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java
@@ -67,7 +67,7 @@
* has a model class, and each model class has its own factory.
* </p>
* <p>
- * Mini-language can be extended by:<br />
+ * Mini-language can be extended by:</p>
* <ul>
* <li>Creating model classes that extend {@link org.apache.ofbiz.minilang.method.MethodOperation}</li>
* <li>Creating factories for the model classes that implement {@link org.apache.ofbiz.minilang.method.MethodOperation.Factory}</li>
@@ -75,7 +75,7 @@
* (see <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html" target="_blank">ServiceLoader</a>)
* </li>
* </ul>
- * </p>
+ *
* @see <a href="https://cwiki.apache.org/confluence/display/OFBADMIN/Mini+Language+-+minilang+-+simple-method+-+Reference">Mini-language Reference</a>
*/
public final class SimpleMethod extends MiniLangElement {
diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java b/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java
index 380331d..f04dfe2 100644
--- a/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java
+++ b/framework/service/src/main/java/org/apache/ofbiz/service/LocalDispatcher.java
@@ -36,20 +36,17 @@
/**
* Disables running of Service Engine Condition Actions (SECAs). Intended to be turned off temporarily.
- * @throws GenericServiceException
*/
void disableEcas();
/**
* Reenables running of Service Engine Condition Actions (SECAs).
- * @throws GenericServiceException
*/
void enableEcas();
/**
* Returns whether Service Engine Condition Actions (SECAs) are disabled or not.
* @return returns whether Service Engine Condition Actions (SECAs) are disabled or not.
- * @throws GenericServiceException
*/
boolean isEcasDisabled();
diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java b/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java
index fecd7b0..f94955b 100644
--- a/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java
+++ b/framework/service/src/main/java/org/apache/ofbiz/service/engine/ScriptEngine.java
@@ -40,13 +40,13 @@
/**
* Generic Script Service Engine. This service engine uses the javax.script package (JSR-223) to invoke scripts or script functions.
- * <p>The script service engine will put the following artifacts in the script engine's bindings:<br />
+ * <p>The script service engine will put the following artifacts in the script engine's bindings:</p>
* <ul>
* <li><code>parameters</code> - the service attributes <code>Map</code></li>
* <li><code>dctx</code> - a <code>DispatchContext</code> instance</li>
* <li><code>dispatcher</code> - a <code>LocalDispatcher</code> instance</li>
* <li><code>delegator</code> - a <code>Delegator</code> instance</li>
- * </ul></p>
+ * </ul>
* <p>If the service definition includes an invoke attribute, then the matching script function/method will be called
* with a single argument - the bindings <code>Map</code>.</p>
*/
diff --git a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java
index 6e7f25e..a9bc3f8 100644
--- a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java
+++ b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/ftl/OfbizUrlTransform.java
@@ -43,14 +43,14 @@
/**
* Freemarker Transform for creating OFBiz URLs (links).
- * <p>This transform accepts several arguments:<br>
+ * <p>This transform accepts several arguments:</p>
* <ul>
* <li><b>fullPath</b> (true/false) - generate a full URL including scheme and host, defaults to false.</li>
* <li><b>secure</b> (true/false) - generate a secure (https) URL, defaults to false. Server settings will
* override this argument.</li>
* <li><b>encode</b> (true/false) - encode the URL, defaults to true. Encoding is UTF-8.</li>
* <li><b>webSiteId</b> - generate a full URL using the web site settings found in the WebSite entity.</li>
- * </ul></p>
+ * </ul>
* <p>In addition, this transform accepts an environment variable - <b>urlPrefix</b>. If the variable
* exists, it is prepended to the contents of the transform (the part between
* <code><@ofbizUrl></code> and <code></@ofbizUrl></code>), and all transform arguments are
diff --git a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java
index e5b01d6..46073e6 100644
--- a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java
+++ b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/WebToolsServices.java
@@ -563,7 +563,8 @@
/** Get entity reference data. Returns the number of entities in
* <code>numberOfEntities</code> and a List of Maps -
- * <code>packagesList</code>.<br/> Each Map contains:<br/>
+ * <code>packagesList</code>.
+ * Each Map contains:<br>
* <ul><li><code>packageName</code> - the entity package name</li>
* <li><code>entitiesList</code> - a list of Maps:
<ul>
diff --git a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java
index 996d98c..0955061 100644
--- a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java
+++ b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/GitHubAuthenticator.java
@@ -90,7 +90,7 @@
* externalAuthId, and the externalAuthId has a valid accessToken in
* GitHubUser entity.
*
- * @param username User's username
+ * @param userLoginId User's login id
* @param password User's password
* @param isServiceAuth true if authentication is for a service call
* @return true if the user is authenticated
diff --git a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java
index 41c7ccc..83848ec 100644
--- a/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java
+++ b/specialpurpose/passport/src/main/java/org/apache/ofbiz/passport/user/LinkedInAuthenticator.java
@@ -91,7 +91,7 @@
* externalAuthId, and the externalAuthId has a valid accessToken in
* LinkedInUser entity.
*
- * @param username User's username
+ * @param userLoginId User's login id
* @param password User's password
* @param isServiceAuth true if authentication is for a service call
* @return true if the user is authenticated
