Accumulo
  1. Accumulo
  2. ACCUMULO-441

Remove warnings from Javadoc generation

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.5.0
    • Component/s: None
    • Labels:

      Description

      There are about 100 warnings. I'll do my best to eliminate them in one commit.

        Activity

        Anonymous made changes -
        Status Closed [ 6 ] Resolved [ 5 ]
        Christopher Tubbs made changes -
        Fix Version/s 1.5.0 [ 12318645 ]
        Fix Version/s 1.5.0-SNAPSHOT [ 12319889 ]
        Gavin made changes -
        Workflow no-reopen-closed, patch-avail [ 12655591 ] patch-available, re-open possible [ 12671770 ]
        Billie Rinaldi made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Hide
        Billie Rinaldi added a comment -

        I completed the merge to 1.4 and back to trunk (which ended up being a good thing because I found a method that was deprecated and removed but wasn't supposed to be). The main thing I changed was the usage of @deprecated. In most cases we had a @deprecated tag with a @see tag on the following line, which isn't helpful when you view the actual javadocs because @see tags are not displayed inline. I changed these to the form "@deprecated use

        {@link class}

        instead" and propose using that in the future.

        Show
        Billie Rinaldi added a comment - I completed the merge to 1.4 and back to trunk (which ended up being a good thing because I found a method that was deprecated and removed but wasn't supposed to be). The main thing I changed was the usage of @deprecated. In most cases we had a @deprecated tag with a @see tag on the following line, which isn't helpful when you view the actual javadocs because @see tags are not displayed inline. I changed these to the form "@deprecated use {@link class} instead" and propose using that in the future.
        Hide
        Billie Rinaldi added a comment -

        The changes look good; I am evaluating whether it would be a good idea to merge the changes back to 1.4 before closing. (This is not our recommended merge direction; normally we would make changes in the branch and merge to trunk. However, it might be better for our users if we slipped these changes in before the 1.4.0 release.)

        Show
        Billie Rinaldi added a comment - The changes look good; I am evaluating whether it would be a good idea to merge the changes back to 1.4 before closing. (This is not our recommended merge direction; normally we would make changes in the branch and merge to trunk. However, it might be better for our users if we slipped these changes in before the 1.4.0 release.)
        David Medinets made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Fix Version/s 1.5.0-SNAPSHOT [ 12319889 ]
        Resolution Fixed [ 1 ]
        Hide
        David Medinets added a comment -

        42 files changed to eliminate javadoc warnings.

        Show
        David Medinets added a comment - 42 files changed to eliminate javadoc warnings.
        David Medinets made changes -
        Status In Progress [ 3 ] Open [ 1 ]
        David Medinets made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        David Medinets made changes -
        Field Original Value New Value
        Remaining Estimate 0h [ 0 ]
        Time Spent 2.5h [ 9000 ]
        Worklog Id 12934 [ 12934 ]
        Hide
        David Medinets added a comment -

        I am down to one last javadoc warning which says:

        noformat
        [WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.commons.collections"
        noformat

        Any idea how to resolve this message?

        Also, I have only changed javadocs comments. The code compiles and the tests run with no errors. Is there anything stopping me from committing to the trunk tomorrow night? 42 files were changed.

        Show
        David Medinets added a comment - I am down to one last javadoc warning which says: noformat [WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.commons.collections" noformat Any idea how to resolve this message? Also, I have only changed javadocs comments. The code compiles and the tests run with no errors. Is there anything stopping me from committing to the trunk tomorrow night? 42 files were changed.
        David Medinets logged work - 02/Mar/12 04:07
        • Time Spent:
          2.5h
           
          Mostly retyped comments into @return area and removed old parameter names.
        David Medinets created issue -

          People

          • Assignee:
            David Medinets
            Reporter:
            David Medinets
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - Not Specified
              Not Specified
              Remaining:
              Remaining Estimate - 0h
              0h
              Logged:
              Time Spent - 2.5h
              2.5h

                Development