Commons Math
  1. Commons Math
  2. MATH-1055

Fix some javadoc errors; add @Deprecated annotations to @deprecated methods

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 3.2
    • Fix Version/s: 3.3
    • Labels:
      None

      Description

      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.

        Activity

        Hide
        Thomas Neidhart added a comment -

        Just a small comment:

        I have seen that you sometimes replace a

        {@link class#method}

        to

        {@link class.method}

        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

        Show
        Thomas Neidhart added a comment - Just a small comment: I have seen that you sometimes replace a {@link class#method} to {@link class.method} 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
        Hide
        Sean Owen added a comment -

        Actually I changed a @link to @code in this case. The target was a method in a test class that is not visible to the non-test code. It is helpful as javadoc, but can't be @link. And if it's just written for humans, "." is the more natural notation.

        Yes '#' is correct in general – I actually didn't think you could use '.' if you wanted to.

        Show
        Sean Owen added a comment - Actually I changed a @link to @code in this case. The target was a method in a test class that is not visible to the non-test code. It is helpful as javadoc, but can't be @link. And if it's just written for humans, "." is the more natural notation. Yes '#' is correct in general – I actually didn't think you could use '.' if you wanted to.
        Hide
        Thomas Neidhart added a comment -

        Ah I missed the change of link to code, then it is fine.
        Thanks!

        Show
        Thomas Neidhart added a comment - Ah I missed the change of link to code, then it is fine. Thanks!
        Hide
        Thomas Neidhart added a comment -

        Committed in r1538354.

        Thanks for the report and patch!

        Show
        Thomas Neidhart added a comment - Committed in r1538354. Thanks for the report and patch!
        Hide
        Luc Maisonobe added a comment -

        Closing all resolved issue now available in released 3.3 version.

        Show
        Luc Maisonobe added a comment - Closing all resolved issue now available in released 3.3 version.

          People

          • Assignee:
            Unassigned
            Reporter:
            Sean Owen
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development