New link pattern when <detectLink> option is set to true

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

New link pattern when <detectLink> option is set to true

Max Zhu
hi,

Wondering if it makes sense to extend <detectLink> option to javadoc.io.

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 change versions.

There are quite a few popular libraries 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

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

Declaimer, I started javadoc.io about 5 years ago and now it's getting more
trendy these days, so I would like to better support this project.

Max


Reference:
https://github.com/apache/maven-javadoc-plugin/blob/b1c029f26c4dc40b29a0e122e5c42b294845acfd/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java#L6526
Reply | Threaded
Open this post in threaded view
|

Re: New link pattern when <detectLink> option is set to true

Enrico Olivelli
Hi Max.
sorry for late reply.

I think your idea is interesting and you work is valuable,
You can follow up by creating a JIRA in issues.apache.org in MJAVADOC
project and then you can also send a PR.
Please add an integration test.

this is the guide for new contributors
https://maven.apache.org/guides/development/guide-helping.html

Enrico

Il giorno ven 1 nov 2019 alle ore 09:26 Max Zhu <[hidden email]> ha
scritto:

> hi,
>
> Any update on this please? Is this mail group actively monitored? or should
> I raise a pull request directly to the project?
>
> Max
>
> On Mon, Oct 28, 2019 at 6:12 PM Max Zhu <[hidden email]> wrote:
>
> > For what's worth I am talking about maven-javadoc-plugin (just realized
> > this is the main maven mail group)
> >
> > On Sat, Oct 26, 2019 at 6:51 PM Max Zhu <[hidden email]> wrote:
> >
> >> hi,
> >>
> >> Wondering if it makes sense to extend <detectLink> option to javadoc.io
> .
> >>
> >> 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 change versions.
> >>
> >> There are quite a few popular libraries 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
> >>
> >> Thus, it will be quite helpful if maven-javadoc-plugin can just
> >> automatically try this url pattern from the dependency list as well.
> >>
> >> Declaimer, I started javadoc.io about 5 years ago and now it's getting
> >> more trendy these days, so I would like to better support this project.
> >>
> >> Max
> >>
> >>
> >> Reference:
> >>
> https://github.com/apache/maven-javadoc-plugin/blob/b1c029f26c4dc40b29a0e122e5c42b294845acfd/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java#L6526
> >>
> >>
> >
>