-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Fix most Javadoc warnings #1420
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
import com.android.build.gradle.BaseExtension | ||
import com.android.build.gradle.LibraryExtension | ||
import com.jfrog.bintray.gradle.BintrayExtension | ||
import com.jfrog.bintray.gradle.tasks.RecordingCopyTask | ||
import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention | ||
|
@@ -32,16 +33,6 @@ allprojects { | |
mavenLocal() | ||
} | ||
|
||
// Skip Javadoc generation for Java 1.8 as it breaks build | ||
if (JavaVersion.current().isJava8Compatible) { | ||
tasks.withType<Javadoc> { | ||
options { | ||
this as StandardJavadocDocletOptions | ||
addStringOption("Xdoclint:none", "-quiet") | ||
} | ||
} | ||
} | ||
|
||
if ((group as String).isNotEmpty() && name != "lint" && name != "internal") { | ||
configureAndroid() | ||
configureQuality() | ||
|
@@ -138,9 +129,18 @@ fun Project.setupPublishing() { | |
} | ||
|
||
val javadoc = task<Javadoc>("javadoc") { | ||
setSource(project.the<BaseExtension>().sourceSets["main"].java.srcDirs) | ||
classpath += configurations["compile"] | ||
classpath += project.files(project.the<BaseExtension>().bootClasspath) | ||
afterEvaluate { | ||
dependsOn(project.the<LibraryExtension>().libraryVariants.map { it.assemble }) | ||
|
||
setSource(project.the<BaseExtension>().sourceSets["main"].java.srcDirs) | ||
classpath += files(project.the<BaseExtension>().bootClasspath) | ||
classpath += files(project.the<LibraryExtension>().libraryVariants.map { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Some code is just ugly in any language haha There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup 😆 |
||
(it.javaCompiler as AbstractCompile).classpath | ||
}) | ||
} | ||
|
||
// Ignore warnings about incomplete documentation | ||
(options as StandardJavadocDocletOptions).addStringOption("Xdoclint:none", "-quiet") | ||
} | ||
|
||
val javadocJar = task<Jar>("javadocJar") { | ||
|
@@ -195,7 +195,7 @@ fun Project.setupPublishing() { | |
}.toTypedArray()) | ||
} | ||
} else { | ||
val pomTask = "generatePomFileFor${project.name.capitalize()}LibraryPublication" | ||
val pomTask = "generatePomFileFor${name.capitalize()}LibraryPublication" | ||
task("prepareArtifacts") { | ||
dependsOn(javadocJar, sourcesJar, "assembleRelease", pomTask) | ||
} | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🍺 pour one out for one of the oldest hacks in the codebase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well technically I just moved it down and changed the comment, but sure, I'll take it. 😁