Maven Javadoc Plugin
  1. Maven Javadoc Plugin
  2. MJAVADOC-280

Allow creation of aggregated javadocs source bundles from project dependencies

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.6.1
    • Fix Version/s: 2.7
    • Labels:
      None
    • Flags:
      Patch

      Description

      It would be nice to have the ability to generate an aggregated javadoc set for a distribution project by resolving the -sources and -test-sources bundles of its dependencies (or, correspondingly, the project.compileSourceRoots and project.testCompileSourceRoots for modules in the same reactor).

      Initially, this might just mean downloading, unpacking, and adding the dependency sources as sourcepaths to the javadoc execution if a flag is set to true (includeDependencySources). Later, we could easily expand this to allow bundling and deployment of the src/main/javadoc directory so that this artifact can be used in the above aggregation approach.

      I've got an implementation of the first part that I will attach to this issue as a patch to illustrate what I'm talking about.

        Issue Links

          Activity

          John Casey created issue -
          John Casey made changes -
          Field Original Value New Value
          Attachment aggregate-from-dependencies.patch [ 48384 ]
          John Casey made changes -
          Patch Submitted [Yes]
          John Casey made changes -
          Fix Version/s 2.6.2 [ 15909 ]
          Assignee John Casey [ jdcasey ]
          John Casey made changes -
          Status Open [ 1 ] Closed [ 6 ]
          Resolution Fixed [ 1 ]
          Fix Version/s 2.7 [ 15050 ]
          Fix Version/s 2.6.2 [ 15909 ]
          John Casey made changes -
          Link This issue duplicates MJAVADOC-265 [ MJAVADOC-265 ]
          jakobk made changes -
          Link This issue relates to MJAVADOC-320 [ MJAVADOC-320 ]
          Geoffrey De Smet made changes -
          Link This issue relates to MJAVADOC-339 [ MJAVADOC-339 ]
          Geoffrey De Smet made changes -
          Link This issue is related to MJAVADOC-340 [ MJAVADOC-340 ]
          Mark Thomas made changes -
          Project Import Sun Apr 05 11:56:47 UTC 2015 [ 1428235007093 ]
          Mark Thomas made changes -
          Workflow jira [ 12722515 ] Default workflow, editable Closed status [ 12762382 ]
          Mark Thomas made changes -
          Patch Submitted Yes [ 10763 ]
          Flags Patch [ 10430 ]
          Mark Thomas made changes -
          Project Import Mon Apr 06 00:11:46 UTC 2015 [ 1428279106587 ]
          Mark Thomas made changes -
          Workflow jira [ 12960007 ] Default workflow, editable Closed status [ 12996805 ]

            People

            • Assignee:
              John Casey
              Reporter:
              John Casey
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development