This is an automated email from the ASF dual-hosted git repository.
jleroux pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
The following commit(s) were added to refs/heads/trunk by this push:
new cbf122b6a Improved: Check and enhance the Javadoc rules/documentation
for the project (OFBIZ-9148)
cbf122b6a is described below
commit cbf122b6af1796ea37efcab579be18cfd88019d9
Author: Jacques Le Roux <[email protected]>
AuthorDate: Thu Mar 13 18:31:17 2025 +0100
Improved: Check and enhance the Javadoc rules/documentation for the project
(OFBIZ-9148)
Remove a bunch of useless </p. that generates warnings: warning: empty <p>
tag
---
.../OFBizActiveDirectoryAuthenticationHandler.java | 2 +-
.../org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java | 2 +-
.../ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java | 2 +-
.../ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java | 2 +-
.../ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java | 2 +-
.../main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java | 2 +-
.../main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java | 8 ++++----
.../java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java | 2 +-
.../java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java | 2 +-
9 files changed, 12 insertions(+), 12 deletions(-)
diff --git
a/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
b/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
index cbfe6667d..8e1293e7b 100644
---
a/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
+++
b/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
@@ -37,7 +37,7 @@ import org.w3c.dom.Element;
/**
- * The OFBiz ActiveDirectory Authentication Handler.<p>
+ * The OFBiz ActiveDirectory Authentication Handler.
*
* The ACL of a user is still controlled by OFBiz.
*
diff --git
a/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
b/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
index c93d3307b..574d3d38e 100644
---
a/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
+++
b/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
@@ -40,7 +40,7 @@ import
org.apache.ofbiz.ldap.commons.InterfaceOFBizAuthenticationHandler;
import org.w3c.dom.Element;
/**
- * The OFBiz CAS-LDAP Authentication Handler.<p>
+ * The OFBiz CAS-LDAP Authentication Handler.
*
* The ACL of a user is still controlled by OFBiz.
*
diff --git
a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
index 39751db2d..8124353a9 100644
---
a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
+++
b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
@@ -53,7 +53,7 @@ import org.apache.ofbiz.service.ServiceUtil;
/**
* The abstract Authentication Handler.
*
- * The ACL of a user is still controlled by OFBiz.<p>
+ * The ACL of a user is still controlled by OFBiz.
*
*/
public abstract class AbstractOFBizAuthenticationHandler implements
InterfaceOFBizAuthenticationHandler {
diff --git
a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java
b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java
index 946137490..cb066515e 100644
---
a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java
+++
b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java
@@ -27,7 +27,7 @@ import javax.servlet.http.HttpServletResponse;
import org.w3c.dom.Element;
/**
- * The OFBiz LDAP Authentication Handler interface.<p>
+ * The OFBiz LDAP Authentication Handler interface.
*
*/
public interface InterfaceOFBizAuthenticationHandler {
diff --git
a/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
b/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
index ff59e56f2..af39c96f0 100644
---
a/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
+++
b/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
@@ -36,7 +36,7 @@ import org.ldaptive.LdapEntry;
import org.w3c.dom.Element;
/**
- * The OFBiz LDAP Authentication Handler.<p>
+ * The OFBiz LDAP Authentication Handler.
*
* The ACL of a user is still controlled by OFBiz.
*
diff --git
a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
index 70476386e..f44e49b6b 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
@@ -24,7 +24,7 @@ import java.util.Locale;
/**
* This is the interface for the report classes which are used for the output
* during operations that run on a separate Thread in OFBiz,
- * like import, export etc.<p>
+ * like import, export etc.
*/
public interface InterfaceReport {
diff --git
a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
index ba910688e..5f928643a 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
@@ -30,15 +30,15 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
- * The ReportEncoder class provides static methods to decode and encode
data.<p>
+ * The ReportEncoder class provides static methods to decode and encode data.
* The methods in this class are substitutes for
<code>java.net.URLEncoder.encode()</code> and
- * <code>java.net.URLDecoder.decode()</code>.<p>
+ * <code>java.net.URLDecoder.decode()</code>.
* The de- and encoding uses the same coding mechanism as JavaScript, special
characters are
- * replaced with <code>%hex</code> where hex is a two digit hex number.<p>
+ * replaced with <code>%hex</code> where hex is a two digit hex number.
* <b>Note:</b> On the client side (browser) instead of using corresponding
<code>escape</code>
* and <code>unescape</code> JavaScript functions, better use
<code>encodeURIComponent</code> and
* <code>decodeURIComponent</code> functions which are work properly with
unicode characters.
- * These functions are supported in IE 5.5+ and NS 6+ only.<p>
+ * These functions are supported in IE 5.5+ and NS 6+ only.
*/
public final class ReportEncoder {
diff --git
a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
index 6ad61cb86..92d09d9e4 100644
---
a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
+++
b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import java.util.Iterator;
/**
- * Provides String utility functions.<p>
+ * Provides String utility functions.
*/
public final class ReportStringUtil {
diff --git
a/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
b/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
index 666348245..32014ed9a 100644
---
a/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
+++
b/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
@@ -27,7 +27,7 @@ import org.apache.ofbiz.htmlreport.InterfaceReportThread;
import org.apache.ofbiz.htmlreport.util.ReportStringUtil;
/**
- * Provides a html report for running parse a PriCat file.<p>
+ * Provides a html report for running parse a PriCat file.
*/
public class PricatParseExcelHtmlReport extends AbstractHtmlReport {
