Uploaded image for project: 'Groovy'
  1. Groovy
  2. GROOVY-7257

groovydoc's help option is misleading

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • 2.3.1
    • 2.4.2
    • GroovyDoc
    • None
    • Windows 7 64-bit

    Description

      When you specify the help option to groovydoc

      groovydoc -help
      

      It sounds like by default only protected and public fields and methods are included in the documentation.

      -protected Show protected/public classes and members (default)
      

      But this is not true as it generates documentation for public, protected, and package classes and members. This what the package option does:

      -package Show package/protected/public classes and members
      

      I kind of think that both options should be removed and that there should be a statement below how to use the groovydoc tool that documents the default behavior.

      usage: groovydoc [options] [packagenames] [sourcefiles]
      
      By default, groovydoc generates documentation for public/protected/package classes and members.
      
      ...
      

      Another issue is the public option which explicitly states that it only generates documentation for public classes and members.

      -public Show only public classes and members
      

      This is not true either as it generates documentation for both public and package classes and members.

      Attachments

        Activity

          People

            paulk Paul King
            tygerpatch Todd Gerspacher
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: