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

add javadoc.io link pattern when <detectLink> option is set to true

    XMLWordPrintableJSON

Details

    • New Feature
    • Status: Closed
    • Major
    • Resolution: Not A Problem
    • next-release
    • None
    • javadoc
    • None

    Description

      For example, google gson (https://github.com/google/gson) has pointed their javadoc to https://www.javadoc.io/doc/com.google.code.gson/gson on their README.md. But currently, maven-javadoc-plugin will only try to fetch https://github.com/google/gson/apidoc/package-list , which apparently is an invalid address. It doesn't make sense to have github, a source control system to keep track of generated files as well.
       
      Many popular libraries are hosting javadoc with javadoc.io already (eg, mockito / spark), and the pattern is very simple as well: https://www.javadoc.io/doc/[group_id]/[artifact_id]/[version_id]/package-list

       This will work with <links> tag, but that's quite tedious as everytime we have to manually keep things in sync when we add / remove dependencies or update dependency versions.

      Thus, it will be quite helpful if maven-javadoc-plugin can just automatically try this url pattern from the dependency list as well.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              maxcellent Max
              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 - 10m
                  10m