You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2026/10/20 13:20:04 UTC

(commons-math) 02/03: Simplify javadoc of the synchronized mutators to inheritDoc only

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

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-math.git

commit 50ba7180e77ce6e616c222290760f758f83730b3
Author: Lyin-OTTF <ht...@gmail.com>
AuthorDate: Tue Oct 20 10:29:08 2026 +0800

    Simplify javadoc of the synchronized mutators to inheritDoc only
    
    Both removeMostRecentValue and replaceMostRecentValue only need the
    inherited documentation; the extra paragraph explaining why the lock is
    taken repeats what addValue already conveys and the class-level contract
    already states.
---
 .../stat/descriptive/SynchronizedDescriptiveStatistics.java       | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/SynchronizedDescriptiveStatistics.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/SynchronizedDescriptiveStatistics.java
index 4b7fa3391..b580ba0c2 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/SynchronizedDescriptiveStatistics.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/SynchronizedDescriptiveStatistics.java
@@ -72,10 +72,6 @@ public class SynchronizedDescriptiveStatistics extends DescriptiveStatistics {
 
     /**
      * {@inheritDoc}
-     *
-     * <p>This method is a mutator like {@link #addValue(double)}, so it has to take the instance lock as well:
-     * {@code DescriptiveStatistics} changes the underlying storeless statistics in place, and without the lock a
-     * concurrent {@code getValues()} could copy the store while it is being updated.</p>
      */
     @Override
     public synchronized void removeMostRecentValue() throws MathIllegalStateException {
@@ -84,10 +80,6 @@ public class SynchronizedDescriptiveStatistics extends DescriptiveStatistics {
 
     /**
      * {@inheritDoc}
-     *
-     * <p>This method is a mutator like {@link #addValue(double)}, so it has to take the instance lock as well:
-     * {@code DescriptiveStatistics} changes the underlying storeless statistics in place, and without the lock a
-     * concurrent {@code getValues()} could copy the store while it is being updated.</p>
      */
     @Override
     public synchronized double replaceMostRecentValue(double v) throws MathIllegalStateException {