commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thomas Neidhart (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MATH-767) Unbalanced <code> usage in javadoc
Date Sun, 01 Apr 2012 17:50:32 GMT

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

Thomas Neidhart commented on MATH-767:
--------------------------------------

Thanks for reporting it.

I have searched the code base for other occurrences of this problem using this regexp:

{noformat}
find -name "*.java" -exec grep -H -e "<code>[^/]*<code>" {} \;
{noformat}

Fix for the remaining files has been done in r1308162.
                
> Unbalanced <code> usage in javadoc
> ----------------------------------
>
>                 Key: MATH-767
>                 URL: https://issues.apache.org/jira/browse/MATH-767
>             Project: Commons Math
>          Issue Type: Improvement
>    Affects Versions: 3.0
>         Environment: n/a
>            Reporter: Dennis Hendriks
>              Labels: javadoc
>             Fix For: 3.1
>
>
> 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. As we can see in the source code for that method:
> {code}
>      * Discards the <code>i<code> last elements of the array.  For example,
> {code}
> this should become:
> {code}
>      * Discards the <code>i</code> last elements of the array.  For example,
> {code}
> as then the <code>...</code> is balanced. Or even better, it could become:
> {code}
>      * Discards the {@code i} last elements of the array.  For example,
> {code}
> This applies elsewhere as well, for instance the isSame(Chromosome) method in the org.apache.commons.math3.genetics.BinaryChromosome
class.
> We should probably check all javadoc, to make sure this is correct everywhere. Since
it is way too much to do manually, maybe a script or other automated check could detect such
cases?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message