Included javadocs with some broken links.
Javadocs are created on my PC, which cannot tie into the FTC API to render the appropriate links. But this is enough to generate docs to explain how to work with the code.
This commit is contained in:
@@ -19,6 +19,21 @@ tasks.withType<JavaCompile> {
|
||||
exclude("**/opmodes/ChuteOpMode.java")
|
||||
}
|
||||
|
||||
tasks.javadoc {
|
||||
// Only generate docs for chute subsystem
|
||||
include("**/subsystems/chute/**")
|
||||
|
||||
// But exclude FTC hardware files (they need Android SDK)
|
||||
exclude("**/FtcMotor.java")
|
||||
exclude("**/FtcPotentiometer.java")
|
||||
exclude("**/opmodes/**")
|
||||
|
||||
// Ignore broken @see references to excluded files
|
||||
options {
|
||||
(this as StandardJavadocDocletOptions).addStringOption("Xdoclint:none", "-quiet")
|
||||
}
|
||||
}
|
||||
|
||||
tasks.test {
|
||||
useJUnitPlatform()
|
||||
testLogging {
|
||||
|
||||
Reference in New Issue
Block a user