[
https://issues.apache.org/jira/browse/MJAVADOC-628?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Max updated MJAVADOC-628:
-------------------------
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|http://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|https://www.javadoc.io/doc/%5Bgroup_id%5D/%5Bartifact_id%5D/%5Bversion_id%5D/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.
was:
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.
I am aware there is already on option to extend <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.
Many popular libraries are hosting javadoc with [javadoc.io|http://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|https://www.javadoc.io/doc/%5Bgroup_id%5D/%5Bartifact_id%5D/%5Bversion_id%5D/package-list]
Thus, it will be quite helpful if maven-javadoc-plugin can just automatically
try this url pattern from the dependency list as well.
> add javadoc.io link pattern when <detectLink> option is set to true
> -------------------------------------------------------------------
>
> Key: MJAVADOC-628
> URL: https://issues.apache.org/jira/browse/MJAVADOC-628
> Project: Maven Javadoc Plugin
> Issue Type: New Feature
> Components: javadoc
> Affects Versions: next-release
> Reporter: Max
> Priority: Major
>
> 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|http://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|https://www.javadoc.io/doc/%5Bgroup_id%5D/%5Bartifact_id%5D/%5Bversion_id%5D/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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
