Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MJAVADOC-729] Link to Javadoc references from JDK 17 #161

Merged
merged 4 commits into from
Sep 15, 2022

Conversation

kwin
Copy link
Member

@kwin kwin commented Sep 14, 2022

Remove mentions when something has been added to ancient JDK 1.4 or 5

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MJAVADOC-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify -Prun-its to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Remove mentions when something has been added to ancient JDK 1.4 or 5
@michael-o
Copy link
Member

Does the Java 17 document when a javadoc(1) config option has been introduced? I mean when reading the docs for 17, applying but Java 8, 11 fails?

@kwin
Copy link
Member Author

kwin commented Sep 14, 2022

Does the Java 17 document when a javadoc(1) config option has been introduced?

No, but IMHO no new option has been introduced since Java 6 (maybe apart from -release with Java 9) and for sure no option has been removed. Apart from that the plugin parameters description mentions when something has been added with a more recent release.

I think pointing to the most recent LTS is reasonable, as Oracle worked quite a bit on the documentation.

Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup!

@kwin kwin merged commit 7cbf434 into master Sep 15, 2022
@kwin kwin deleted the feature/update-links-to-javadoc-documentation branch September 15, 2022 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants