Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-100

Allow JavaDocs to generate for Test Code

    XMLWordPrintableJSON

Details

    • New Feature
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • None
    • 2.3
    • None
    • None

    Description

      I have two use cases.

      First, my team is trying to be very diligent in creating JavaDocs for all our code. We have checkstyle checking that javadocs are written for every method within test code. So, since we're putting this much effort into our javadocs, it's a "nice to have" for those javadocs to actually be generated on the project site.

      Second, I have some "Test Harness" code in one project, and this is re-usable code which many projects should make use of in their test code. I would like to have that code's javadocs available on its project site for obvious reasons.

      There is probably some workaround that I could figure out and make this work, but much like the Checkstyle plugin has an includeTestSourceDirectory property for its goal, adding that type of property to the javadoc plugin would be an intuitive way to turn on javadocs for test code.

      Attachments

        Issue Links

          Activity

            People

              siveton Siveton Vincent
              jacob.robertson Jacob Robertson
              Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: