commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thomas Neidhart (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MATH-1055) Fix some javadoc errors; add @Deprecated annotations to @deprecated methods
Date Sun, 03 Nov 2013 10:58:17 GMT

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

Thomas Neidhart commented on MATH-1055:
---------------------------------------

Just a small comment:

I have seen that you sometimes replace a {noformat}{@link class#method}{noformat} to {noformat}{@link
class.method}{noformat}

According to the oracle javadoc guide and common practice in commons, we prefer the variant
with hash: 

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

> Fix some javadoc errors; add @Deprecated annotations to @deprecated methods
> ---------------------------------------------------------------------------
>
>                 Key: MATH-1055
>                 URL: https://issues.apache.org/jira/browse/MATH-1055
>             Project: Commons Math
>          Issue Type: Improvement
>    Affects Versions: 3.2
>            Reporter: Sean Owen
>            Priority: Trivial
>         Attachments: MATH-1055.patch
>
>
> And here is another patch touching up some javadoc problems -- missing or outdated references,
and along the way, adding @Deprecated annotations to methods javadoc'ed as @deprecated.



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Mime
View raw message