This is an automated email from the ASF dual-hosted git repository.
jleroux pushed a commit to branch trunk
in repositoryhttps://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new 4c7398dd36 Improved: Check and enhance the Javadoc
rules/documentation for the project (OFBIZ-9148)
4c7398dd36 is described below
commit 4c7398dd3615608736ae869f9693e5254d0f25d1
Author: Jacques Le Roux<jacques.le.r...@les7arts.com>
AuthorDate: Thu Mar 13 17:58:34 2025 +0100
Improved: Check and enhance the Javadoc rules/documentation for the
project (OFBIZ-9148)
Remove a bunch of useless </p. According to
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format
<p> is enough, see result here:
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#exampleresult
---
.asf.yaml | 13 +++++++++++++
.../ofbiz/workeffort/workeffort/WorkEffortServices.java | 6 +++---
.../java/org/apache/ofbiz/base/container/Container.java | 4 ++--
.../main/java/org/apache/ofbiz/base/util/Observable.java | 2 +-
.../main/java/org/apache/ofbiz/base/util/ScriptHelper.java | 2 +-
.../src/main/java/org/apache/ofbiz/base/util/Scriptlet.java | 2 +-
.../org/apache/ofbiz/common/email/NotificationServices.java | 10 +++++-----
.../org/apache/ofbiz/entity/condition/EntityOperator.java | 5 +++--
.../apache/ofbiz/entity/datasource/GenericHelperInfo.java | 2 +-
.../main/java/org/apache/ofbiz/minilang/SimpleMethod.java | 2 +-
.../minilang/method/conditional/ConditionalFactory.java | 2 +-
.../org/apache/ofbiz/service/config/ServiceConfigUtil.java | 2 +-
.../src/main/java/org/apache/ofbiz/base/start/Start.java | 6 +++---
.../java/org/apache/ofbiz/base/start/StartupCommand.java | 2 +-
.../org/apache/ofbiz/base/start/StartupCommandUtil.java | 2 +-
15 files changed, 38 insertions(+), 24 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index ba89ae6426..7685c151c4 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -32,6 +32,19 @@ github:
- content
- geospatial
- hacktoberfest
+ enabled_merge_buttons:
+ # enable squash button:
+ squash: true
+ # default commit message when merging with a squash commit
+ # can either be: DEFAULT | PR_TITLE | PR_TITLE_AND_COMMIT_DETAILS |
PR_TITLE_AND_DESC
+ squash_commit_message: PR_TITLE_AND_DESC
+ # enable merge button:
+ merge: true
+ # default commit message when merging with a merge commit
+ # can either be: DEFAULT | PR_TITLE | PR_TITLE_AND_DESC
+ merge_commit_message: PR_TITLE_AND_DESC
+ # disable rebase button:
+ rebase: false
notifications:
jobs:notificati...@ofbiz.apache.org
diff --git a/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortServices.java
b/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortServices.java
index 803fba9bed..5fff1f7307 100644
---
a/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortServices.java
+++
b/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/WorkEffortServices.java
@@ -460,7 +460,7 @@ public class WorkEffortServices {
* Get Work Efforts by period.
* <p>
* This method takes the following parameters:
- * </p>
+ *
* <ul>
* <li>start - TimeStamp (Period start date/time)</li>
* <li>numPeriods - Integer</li>
@@ -478,11 +478,11 @@ public class WorkEffortServices {
* <b>periods</b> - one List element per period. It also returns a
* <b>maxConcurrentEntries</b> Integer - which indicates the maximum
number of
* Work Efforts found in one period.
- * </p>
+ *
* <p>
* Each <b>periods</b> list element is a Map containing the following
* key/value pairs:
- * </p>
+ *
* <ul>
* <li>start - TimeStamp (Period start date/time)</li>
* <li>end - TimeStamp (Period end date/time)</li>
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/container/Container.java
b/framework/base/src/main/java/org/apache/ofbiz/base/container/Container.java
index 7db6f1f26c..065bc40f85 100644
---
a/framework/base/src/main/java/org/apache/ofbiz/base/container/Container.java
+++
b/framework/base/src/main/java/org/apache/ofbiz/base/container/Container.java
@@ -34,9 +34,9 @@ import org.apache.ofbiz.base.start.StartupCommand;
* separate shutdown thread will call the <code>stop</code> method of each
container.
* Implementations should anticipate asynchronous calls to the methods by
different
* threads.
- * </p>
*
- * <p>Containers might be loaded more than once (have more than one
instance).<p>
+ *
+ * <p>Containers might be loaded more than once (have more than one instance).
*/
public interface Container {
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java
index f766febb36..a7b0224d07 100644
--- a/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java
+++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java
@@ -89,7 +89,7 @@ public final class Observable {
* <p>Each {@code Observer} has its {@code update} method called with two
* arguments: this observable object and {@code null}. In other
* words, this method is equivalent to:
- * </p>
+ *
* <blockquote>
* {@code notifyObservers(null)}
* </blockquote>
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptHelper.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptHelper.java
index 0ce95e7bc3..9a0170e6b9 100644
--- a/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptHelper.java
+++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptHelper.java
@@ -31,7 +31,7 @@ import javax.script.ScriptException;
* <code>partyValue = ofbiz.findOne("Party");</code><br>
* while other languages might access it as a native method or function:<br>
* <code>partyValue = findOne("Party");</code>
- * </p>
+ *
*/
public interface ScriptHelper {
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/Scriptlet.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/Scriptlet.java
index b88fd5b4cd..d732f94499 100644
--- a/framework/base/src/main/java/org/apache/ofbiz/base/util/Scriptlet.java
+++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/Scriptlet.java
@@ -25,7 +25,7 @@ import java.util.Map;
* <p>A scriptlet is a small script that is commonly found in a scripting XML
file.
* The scriptlet is composed of two parts: the prefix - which is the script
language
* followed by a colon (":"), and the script. Example: <code>groovy:return
foo.bar();</code>.
- * </p>
+ *
*/
public final class Scriptlet {
diff --git a/framework/common/src/main/java/org/apache/ofbiz/common/email/NotificationServices.java
b/framework/common/src/main/java/org/apache/ofbiz/common/email/NotificationServices.java
index da3ac174ac..c334224e50 100644
---
a/framework/common/src/main/java/org/apache/ofbiz/common/email/NotificationServices.java
+++
b/framework/common/src/main/java/org/apache/ofbiz/common/email/NotificationServices.java
@@ -52,12 +52,12 @@ import freemarker.template.TemplateException;
* <a
href="http://freemarker.sourceforge.net/docs/dgui_quickstart_template.html";>
* Freemarker Template</a> mapping the required fields of the template to the
* required attributes of the service.
- * </p>
+ *
* <p>
* This service definition should extend the
<code>sendNotificationInterface</code>
* or the <code>prepareNotificationInterface</code> service interface
* and simply invoke the associated method defined in this class.
- * </p>
+ *
* <pre>
* {@code
* <service name="sendPoPickupNotification" engine="java"
@@ -75,7 +75,7 @@ import freemarker.template.TemplateException;
* invoked or let the <code>NotificationService</code> attempt to resolve it
* as best it can, see {@link #setBaseUrl(Delegator, String, Map)
setBaseUrl(Map)}
* for details on how this is achieved.
- * </p>
+ *
* The following example shows what a simple notification message template,
* associated with the above service, might contain:
* <blockquote>
@@ -88,7 +88,7 @@ import freemarker.template.TemplateException;
* The template file must be found on the classpath at runtime and
* match the "templateName" field passed to the service when it
* is invoked.
- * </p>
+ *
* <p>
* For complex messages with a large number of dynamic fields, it may be wise
* to implement a custom service that takes one or two parameters that can
@@ -96,7 +96,7 @@ import freemarker.template.TemplateException;
* the {@link #prepareNotification(DispatchContext, Map)
prepareNotification(DispatchContext, Map)}
* or {@link #sendNotification(DispatchContext, Map)
sendNotification(DispatchContext, Map)}
* methods directly to generate or generate and send the notification
respectively.
- * </p>
+ *
*/
public class NotificationServices {
diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityOperator.java
b/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityOperator.java
index d261671260..0ad44d6be7 100644
---
a/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityOperator.java
+++
b/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityOperator.java
@@ -404,7 +404,8 @@ public abstract class EntityOperator<L, R> implements
Serializable {
/**
* Comparison operator for <code>Collection</code> types.
- * @param <E>
+ * @param Comparable of type E
+ * @param Collection of Comparable of type E
*/
public abstract static class CollectionEntityComparisonOperator<E> extends
EntityComparisonOperator<Comparable<E>, Collection<Comparable<E>>> {
public CollectionEntityComparisonOperator(int id, String code) {
@@ -414,7 +415,7 @@ public abstract class EntityOperator<L, R> implements
Serializable {
/**
* Comparison operator for <code>Comparable</code> types.
- * @param <E>
+ * @param Comparable of type E
*/
public abstract static class ComparableEntityComparisonOperator<E> extends
EntityComparisonOperator<Comparable<E>, E> {
public ComparableEntityComparisonOperator(int id, String code) {
diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperInfo.java
b/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperInfo.java
index c01a5888c4..f0096452ff 100644
---
a/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperInfo.java
+++
b/framework/entity/src/main/java/org/apache/ofbiz/entity/datasource/GenericHelperInfo.java
@@ -23,7 +23,7 @@ package org.apache.ofbiz.entity.datasource;
* A container for data source connection information.
* <p><b>Note that this class is not synchronized.</b>
* If multiple threads access a <code>GenericHelperInfo</code> concurrently
it must be synchronized externally.
- * </p>
+ *
*/
public final class GenericHelperInfo {
private final String entityGroupName;
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 7572f20299..3dc093baaa 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
@@ -65,7 +65,7 @@ import org.w3c.dom.Element;
* design pattern. Mini-language XML files are parsed twice - first into a
W3C DOM
* tree, then the DOM tree is parsed into element model objects. Each XML
element
* has a model class, and each model class has its own factory.
- * </p>
+ *
* <p>
* Mini-language can be extended by:</p>
* <ul>
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/conditional/ConditionalFactory.java
b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/conditional/ConditionalFactory.java
index 4af4f0e679..82b1ac7453 100644
---
a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/conditional/ConditionalFactory.java
+++
b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/conditional/ConditionalFactory.java
@@ -34,7 +34,7 @@ import org.w3c.dom.Element;
* An abstract factory class for creating <if> element sub-element
implementations.
* <p>Mini-language can be extended to support additional condition elements
* by extending this class to provide custom conditional element
implementations.
- * </p>
+ *
*/
public abstract class ConditionalFactory<C extends Conditional> {
diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/config/ServiceConfigUtil.java
b/framework/service/src/main/java/org/apache/ofbiz/service/config/ServiceConfigUtil.java
index 99f13995b0..e7359126b3 100644
---
a/framework/service/src/main/java/org/apache/ofbiz/service/config/ServiceConfigUtil.java
+++
b/framework/service/src/main/java/org/apache/ofbiz/service/config/ServiceConfigUtil.java
@@ -41,7 +41,7 @@ import org.w3c.dom.Element;
* the service configuration file. Client code that depends on the
<code>serviceengine.xml</code>
* file can be notified when the file is reloaded by implementing
<code>ServiceConfigListener</code>
* and registering itself using the {@link
#registerServiceConfigListener(ServiceConfigListener)}
- * method.<p>
+ * method.
*/
public final class ServiceConfigUtil {
diff --git a/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
b/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
index daf6befc13..62a6765146 100644
--- a/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
+++ b/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
@@ -32,16 +32,16 @@ import org.apache.ofbiz.base.container.ContainerLoader;
* <p>
* This class implements a thread-safe state machine. The design is critical
* for reliable starting and stopping of the server.
- * </p>
+ *
* <p>
* The machine's current state and state changes must be encapsulated in this
* class. Client code may query the current state, but it may not change it.
- * </p>
+ *
* <p>
* This class uses a singleton pattern to guarantee that only one server
instance
* is running in the VM. Client code retrieves the instance by using the
* {@code getInstance()} static method.
- * </p>
+ *
*/
public final class Start {
diff --git a/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommand.java
b/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommand.java
index a8560e6561..7254b4574d 100644
---
a/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommand.java
+++
b/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommand.java
@@ -28,7 +28,7 @@ import java.util.Map;
* A {@code StartupCommand} represents a processed command line argument
passed
* to OFBiz such that it is no longer a raw string but an instance of this
class.
* For example: {@code java -jar build/libs/ofbiz.jar --status} where status
is a command.
- * </p>
+ *
*/
public final class StartupCommand {
private String name;
diff --git a/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommandUtil.java
b/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommandUtil.java
index 3dc81b88b1..53bb3b93ab 100644
---
a/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommandUtil.java
+++
b/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupCommandUtil.java
@@ -45,7 +45,7 @@ import org.apache.commons.cli.ParseException;
* <p>
* Defines OFBiz startup options called through main e.g. --load-data or
--help
* in addition to utility methods for parsing and handling these options
- * </p>
+ *
*/
public final class StartupCommandUtil {
