Uploaded image for project: 'ActiveMQ Classic'
  1. ActiveMQ Classic
  2. AMQ-9074

remove various .js dependencies and source listing from javadoc output

    XMLWordPrintableJSON

Details

    • Task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 5.17.2
    • 5.18.0, 5.17.3
    • Documentation
    • None

    Description

      Following https://openjdk.org/jeps/225), the javadoc output on JDK9+ has included a search box. To enable this various javascript files and a zipped index are included in the javadoc output. This means they were introduced to the javadoc output once the project required Java 11, i.e from 5.17.0, as previously Java 8 was used to run the release builds. These files are of whatever version the JDK used to run the build has included, and can tend to get stale (as per ARTEMIS-3971)

      Setting the -noindex option when building the javadoc removes the search, so we can add this option and remove the need to deal with these files going stale in future. 

      Many of the javadoc build configs currently configure inclusion of an HTML source listing, which results in a fairly huge (>200MB) and yet often redundant output. Complete sources are easily available via github etc, and the sources and javadocs are also published to Maven Central where IDEs will grab them, which is likely how/where many people will look at sources+javadocs these days. There seems to be little need to burn the time and space including a HTML source listing, so this also looks to disable that.

      Attachments

        Activity

          People

            cshannon Christopher L. Shannon
            robbie Robbie Gemmell
            Votes:
            0 Vote for this issue
            Watchers:
            2 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 - 0.5h
                0.5h