[ 
https://issues.apache.org/jira/browse/OFBIZ-12742?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17936008#comment-17936008
 ] 

Jacques Le Roux commented on OFBIZ-12742:
-----------------------------------------

For an unknown reason the previous commit was not associated with this Jira. 
Here it is:
{quote}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-framework.git]

The following commit(s) were added to refs/heads/trunk by this push:
new 8f4b688088 Improved: Fix Javadoc warnings (OFBIZ-12742)
8f4b688088 is described below

commit 8f4b688088bb85a1234b6f40c022a890705e2d05
Author: Jacques Le Roux <jacques.le.r...@les7arts.com>
AuthorDate: Fri Mar 14 17:22:56 2025 +0100

Improved: Fix Javadoc warnings (OFBIZ-12742)

Slightly improves AbstractCache class. But I don't understand yet why it still
claims that:

AbstractCache.java:23: warning: no comment
public abstract class AbstractCache {
^
AbstractCache.java:27: warning: no comment
protected AbstractCache(String id) {
—
.../main/java/org/apache/ofbiz/entity/cache/AbstractCache.java | 8 ++++++++
1 file changed, 8 insertions(+)

diff --git 
a/framework/entity/src/main/java/org/apache/ofbiz/entity/cache/AbstractCache.java
 
b/framework/entity/src/main/java/org/apache/ofbiz/entity/cache/AbstractCache.java
index 32bbe5a5ff..ecb3158aa4 100644
— 
a/framework/entity/src/main/java/org/apache/ofbiz/entity/cache/AbstractCache.java
+++ 
b/framework/entity/src/main/java/org/apache/ofbiz/entity/cache/AbstractCache.java
@@ -22,12 +22,20 @@ import org.apache.ofbiz.base.util.cache.UtilCache;
import org.apache.ofbiz.entity.Delegator;
import org.apache.ofbiz.entity.DelegatorFactory;

+/**
+ * EntityCache cache created in function of a delegator and an id
+ */
public abstract class AbstractCache<K, V> {

private final String delegatorName;
private final String id;
private final String cacheNamePrefix;

+ /**
+ * Create an abstract cache for an entity in function of a delegator and an id
+ * @param delegatorName defines the delegator used by the cache
+ * @param id identifies the cache in function of a delegator
+ */
protected AbstractCache(String delegatorName, String id) {
this.delegatorName = delegatorName;
this.id = id;
{quote}

> Fix Javadoc warnings
> --------------------
>
>                 Key: OFBIZ-12742
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-12742
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: Upcoming Branch, 22.01.01
>            Reporter: Jacques Le Roux
>            Assignee: Jacques Le Roux
>            Priority: Major
>             Fix For: Upcoming Branch
>
>
> There is an important number of Javadoc warnings  (> 100) in both trunk and 
> 22.01



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to