You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by mr...@apache.org on 2026/10/27 13:03:38 UTC

(ofbiz-framework) 02/02: Fix documentation comments that are not attached to any declaration

This is an automated email from the ASF dual-hosted git repository.

mridulpathak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git

commit 522792d5cf32fde3ce3ca738ac7df846f0cee4df
Author: Mridul Pathak <mr...@gmail.com>
AuthorDate: Tue Oct 27 18:13:26 2026 +0530

    Fix documentation comments that are not attached to any declaration
    
    - Start the license headers of GenericMap, ReportHelper and SecuredUpload with /*, since a typo and a leading blank line kept the script from matching them.
    - Move the record component comments of SecretAuditEvent into @param tags of the record Javadoc.
    - Put @Override after the Javadoc of the isFinished method in RequestWrapper.
    - Remove a //// separator line in TechDataServices, which javac reads as a Markdown documentation comment.
---
 .../manufacturing/techdata/TechDataServices.java   |  1 -
 .../ofbiz/marketing/report/ReportHelper.java       |  2 +-
 .../org/apache/ofbiz/base/util/RequestWrapper.java |  2 +-
 .../ofbiz/base/util/collections/GenericMap.java    |  2 +-
 .../org/apache/ofbiz/security/SecuredUpload.java   |  2 +-
 .../ofbiz/webtools/secret/SecretAuditEvent.java    | 23 +++++++++++-----------
 6 files changed, 16 insertions(+), 16 deletions(-)

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 4b85ad190b..b0b9cb7153 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
@@ -388,7 +388,6 @@ public class TechDataServices {
         return dateTo;
     }
 
-    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     /** Used to find the last day in the TechDataCalendarWeek where capacity != 0, ending at dayEnd, dayEnd included.
      * @param techDataCalendarWeek        The TechDataCalendarWeek cover
      * @param dayEnd
diff --git a/applications/marketing/src/main/java/org/apache/ofbiz/marketing/report/ReportHelper.java b/applications/marketing/src/main/java/org/apache/ofbiz/marketing/report/ReportHelper.java
index 21b695d6de..92d3505d4d 100644
--- a/applications/marketing/src/main/java/org/apache/ofbiz/marketing/report/ReportHelper.java
+++ b/applications/marketing/src/main/java/org/apache/ofbiz/marketing/report/ReportHelper.java
@@ -1,5 +1,5 @@
 
-/*******************************************************************************
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/RequestWrapper.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/RequestWrapper.java
index dc4bdd1a51..a3291ae6ff 100644
--- a/framework/base/src/main/java/org/apache/ofbiz/base/util/RequestWrapper.java
+++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/RequestWrapper.java
@@ -93,10 +93,10 @@ public class RequestWrapper extends HttpServletRequestWrapper {
                 return len;
             }
 
-            @Override
             /**
              * Needed by Servlet 3.1 No worry this is not used in OFBiz code
              */
+            @Override
             public boolean isFinished() {
                 return false;
             }
diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/GenericMap.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/GenericMap.java
index 441b67aed7..c4c075cb60 100644
--- a/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/GenericMap.java
+++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/collections/GenericMap.java
@@ -1,4 +1,4 @@
-/*******n***********************************************************************
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
diff --git a/framework/security/src/main/java/org/apache/ofbiz/security/SecuredUpload.java b/framework/security/src/main/java/org/apache/ofbiz/security/SecuredUpload.java
index 378b7d5469..d6abc6befe 100644
--- a/framework/security/src/main/java/org/apache/ofbiz/security/SecuredUpload.java
+++ b/framework/security/src/main/java/org/apache/ofbiz/security/SecuredUpload.java
@@ -1,5 +1,5 @@
 
-/*******************************************************************************
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
diff --git a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/secret/SecretAuditEvent.java b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/secret/SecretAuditEvent.java
index ba3b9fca8d..4b48a30178 100644
--- a/framework/webtools/src/main/java/org/apache/ofbiz/webtools/secret/SecretAuditEvent.java
+++ b/framework/webtools/src/main/java/org/apache/ofbiz/webtools/secret/SecretAuditEvent.java
@@ -32,29 +32,30 @@ import java.util.Objects;
  * <p><strong>Security invariant:</strong> this record never holds a secret value,
  * vault path, or authentication credential. {@code secretKeyRef} is the logical
  * key name only (e.g. {@code jdbc-password.default}).</p>
+ *
+ * @param userLoginId Null for scheduler/system jobs that have no login session.
+ * @param clientIpAddress Null for non-HTTP call sites (scheduler jobs, runSync calls).
+ * @param secretKeyRef Logical key name — e.g. {@code jdbc-password.default}. Never a vault path or ARN.
+ * @param secretTarget {@code SYSTEM_PROPERTY | PASSWORDS_FILE | UNKNOWN}
+ * @param action Required. One of the action values defined in the audit taxonomy (Section 4 of the design).
+ * @param accessMode {@code PROVIDER_CALL | CACHE_HIT | FALLBACK_FILE | ENV_VAR | NOT_APPLICABLE}
+ * @param providerType Active provider name at call time — from {@code SecretProviderFactory.getProviderName()}.
+ * @param outcome Required. One of the outcome values defined in the audit taxonomy (Section 4 of the design).
+ * @param errorCategory Null unless {@code outcome=FAILURE}. One of: {@code AUTH_FAILED | NETWORK_TIMEOUT | PROVIDER_ERROR | INVALID_CONFIG}
+ * @param systemResourceId Nullable — populated for SYNC / STORE / ROTATION_POLL events against a SystemProperty row.
+ * @param systemPropertyId Nullable — populated for SYNC / STORE / ROTATION_POLL events against a SystemProperty row.
  */
 public record SecretAuditEvent(
-        /** Null for scheduler/system jobs that have no login session. */
         String userLoginId,
-        /** Null for non-HTTP call sites (scheduler jobs, runSync calls). */
         String clientIpAddress,
-        /** Logical key name — e.g. {@code jdbc-password.default}. Never a vault path or ARN. */
         String secretKeyRef,
-        /** {@code SYSTEM_PROPERTY | PASSWORDS_FILE | UNKNOWN} */
         String secretTarget,
-        /** Required. One of the action values defined in the audit taxonomy (Section 4 of the design). */
         String action,
-        /** {@code PROVIDER_CALL | CACHE_HIT | FALLBACK_FILE | ENV_VAR | NOT_APPLICABLE} */
         String accessMode,
-        /** Active provider name at call time — from {@code SecretProviderFactory.getProviderName()}. */
         String providerType,
-        /** Required. One of the outcome values defined in the audit taxonomy (Section 4 of the design). */
         String outcome,
-        /** Null unless {@code outcome=FAILURE}. One of: {@code AUTH_FAILED | NETWORK_TIMEOUT | PROVIDER_ERROR | INVALID_CONFIG} */
         String errorCategory,
-        /** Nullable — populated for SYNC / STORE / ROTATION_POLL events against a SystemProperty row. */
         String systemResourceId,
-        /** Nullable — populated for SYNC / STORE / ROTATION_POLL events against a SystemProperty row. */
         String systemPropertyId) {
 
     public static Builder builder() {