commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dennis Hendriks <D.Hendr...@tue.nl>
Subject [math] javadoc unbalanced <code>
Date Fri, 09 Mar 2012 10:34:16 GMT
Hi all,

See http://commons.apache.org/math/apidocs/index-all.html and scroll to the 
section 'D'. Observe how in method discardMostRecentElements(int) in class 
org.apache.commons.math3.util.ResizableDoubleArray, the style changes to 
larger font. This can be fixed using this patch:


Index: src/main/java/org/apache/commons/math3/util/ResizableDoubleArray.java
===================================================================
--- src/main/java/org/apache/commons/math3/util/ResizableDoubleArray.java 
      (revision 1298781)
+++ src/main/java/org/apache/commons/math3/util/ResizableDoubleArray.java 
      (working copy)
@@ -457,7 +457,7 @@
      }

      /**
-     * Discards the <code>i<code> last elements of the array.  For example,
+     * Discards the <code>i</code> last elements of the array.  For example,
       * if the array contains the elements 1,2,3,4, invoking
       * <code>discardMostRecentElements(2)</code> will cause the last two 
elements
       * to be discarded, leaving 1,2 in the array.  Throws 
illegalArgumentException


and is obviously due to <code>i</code> not being balanced. Similar issues 
exist elsewhere in the javadoc, for instance at the isSame(Chromosome) 
method in the org.apache.commons.math3.genetics.BinaryChromosome class.

Best regards,
Dennis

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message