Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.0
    • Fix Version/s: 1.1
    • Component/s: CLI-1.x
    • Labels:
      None
    • Environment:

      Operating System: other
      Platform: Other

    • Bugzilla Id:
      15542

      Description

      There is almost no Javadoc for the class org.apache.commons.cli.HelpFormatter.

        Activity

        Hide
        dominik.stadler@gmx.at Dominik Stadler added a comment -

        Created an attachment (id=7688)
        A patch that adds javadoc to all public methods

        Show
        dominik.stadler@gmx.at Dominik Stadler added a comment - Created an attachment (id=7688) A patch that adds javadoc to all public methods
        Hide
        dominik.stadler@gmx.at Dominik Stadler added a comment -

        I tried to provide descriptions at least for all public methods in the class.
        Please perform a quick check if I described the parameters correctly.

        Show
        dominik.stadler@gmx.at Dominik Stadler added a comment - I tried to provide descriptions at least for all public methods in the class. Please perform a quick check if I described the parameters correctly.
        Hide
        dominik.stadler@gmx.at Dominik Stadler added a comment -

        I just now found out that according to
        http://cvs.apache.org/viewcvs/jakarta-commons/cli/src/java/org/apache/commons/cli/HelpFormatter.java.diff?r1=1.11&r2=1.12&diff_format=h
        the file has JavaDoc in CVS since December.

        Can you please close bugs when fixes are applied to prevent others to work on
        things that are long fixed!

        Show
        dominik.stadler@gmx.at Dominik Stadler added a comment - I just now found out that according to http://cvs.apache.org/viewcvs/jakarta-commons/cli/src/java/org/apache/commons/cli/HelpFormatter.java.diff?r1=1.11&r2=1.12&diff_format=h the file has JavaDoc in CVS since December. Can you please close bugs when fixes are applied to prevent others to work on things that are long fixed!
        Hide
        yoavs@computer.org Yoav Shapira added a comment -

        JavaDoc seems fairly complete and accurate, closing bug.

        Show
        yoavs@computer.org Yoav Shapira added a comment - JavaDoc seems fairly complete and accurate, closing bug.

          People

          • Assignee:
            Unassigned
            Reporter:
            garydgregory Gary Gregory
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development