Don't use groovy to generate javadoc #26
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a package-info.class file to the generated jar but it shouldn't be a problem This is because maven uses the jar as the input to the javadoc tool and we don't want to diverge too much from the maven way (you get problems really fast) (In theory, I guess we could generated the javadoc from target/classes instead of target/project.jar) The generated javadoc has one package with one class because: - It doesn't seem to be possible to generate an empty javadoc (no packages). - It doesn't seem to be possible to generate an empty package (no classes). references: * https://stackoverflow.com/questions/53706943/how-to-upload-an-artifact-to-maven-central-with-an-empty-javadoc-jar-or-empty-s => what we did in 1.0.0 and 1.0.1: totally empty javadoc.jar (valid for maven central upload but ugly) * https://stackoverflow.com/questions/59071851/how-to-force-a-javadoc-jar-even-though-there-is-no-public-javadoc => still produces a totally empty javadoc.jar (and big scary red errors) * https://stackoverflow.com/questions/1138390/javadoc-for-package-info-java-only => This plus excluding the class from the jar seems like the best solution for now ? promising but not yet ready: * https://issues.apache.org/jira/browse/MJAVADOC-329 apache/maven-javadoc-plugin#65 * https://bugs.openjdk.org/browse/JDK-8193107 https://hg.openjdk.org/jdk/jdk/rev/111104f1e033 empty modules are allowed, but does becoming a module work with how the native library are loaded ?? Signed-off-by: HARPER Jon <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
no
What kind of change does this PR introduce?
Feature
What is the current behavior?
uses groovy to generate a fake javadoc
What is the new behavior (if this is a feature change)?
uses javadoc to generate a javadoc talking about the native lib contents of this jar
Does this PR introduce a breaking change or deprecate an API?
NO
Other information: