Skip to content

Improve Javadoc generation #496

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.

Sign up for GitHub

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

Merged
jimmyjames merged 3 commits into from
Apr 28, 2021
Merged

Improve Javadoc generation #496

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e745182
Use JDK 16 for javadoc generation
Marcono1234 Mar 31, 2021
64cb404
Exclude internal `impl` package from javadoc
Marcono1234 Apr 25, 2021
92b95a5
Merge branch 'master' into marcono1234/javadoc-improvements
jimmyjames Apr 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions lib/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,32 @@ oss {
}
}

def javaVersion = 8
java {
toolchain {
languageVersion = JavaLanguageVersion.of(8)
languageVersion = JavaLanguageVersion.of(javaVersion)
}
}

compileJava {
sourceCompatibility '1.8'
targetCompatibility '1.8'
sourceCompatibility "$javaVersion"
targetCompatibility "$javaVersion"
}

// Use latest JDK for javadoc generation
tasks.withType(Javadoc).configureEach {
javadocTool = javaToolchains.javadocToolFor {
languageVersion = JavaLanguageVersion.of(16)
}
}

javadoc {
// Exclude internal implementation package from javadoc
excludes = ['com/auth0/jwt/impl']
// Specify Java version this project uses
// Otherwise would use version of javadoc toolchain by default which could
// cause compilation error mismatch between compileJava and javadoc creation
options.addStringOption('-release', "$javaVersion")
}

dependencies {
Expand Down