maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [maven-javadoc-plugin] anthonyvdotbe opened a new pull request #50: [MJAVADOC-623] - Provide a fallback for api-element-list
Date Sat, 25 Jul 2020 17:48:17 GMT

anthonyvdotbe opened a new pull request #50:
URL: https://github.com/apache/maven-javadoc-plugin/pull/50


   This allows to build with a JDK for which the plugin does not contain a `java-api-element-list-XX`
file yet.
   
   ## what
   When building with a JDK version XX, for which the plugin does not contain a `java-api-element-list-XX`
file yet, the plugin falls back to the most recent `api-element-list` file that is available.
   
   ## how
   By starting at XX, and decrementing the version as needed until a `java-api-element-list-XX`
file is found.
   
   ## why
   Otherwise [this `if` statement](https://github.com/apache/maven-javadoc-plugin/blob/master/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java#L6410)
is false, no `api-element-list` file is copied, the error from [MJAVADOC-623](https://issues.apache.org/jira/browse/MJAVADOC-623)
occurs, and the Javadoc doesn't contain any links.
   
   ## checklist
   
   Following this checklist to help us incorporate your 
   contribution quickly and easily:
   
    - [x] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MJAVADOC)
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.
    - [x] Each commit in the pull request should have a meaningful subject line and body.
    - [x] 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.
    - [x] Write a pull request description that is detailed enough to understand what the
pull request does, how, and why.
    - [x] 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](https://www.apache.org/licenses/icla.pdf) 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](http://www.apache.org/licenses/LICENSE-2.0)
   you have to acknowledge this by using the following check-box.
   
    - [x] I hereby declare this contribution to be licenced under the [Apache License Version
2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
   
    - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message