/**
 * Configuration for generating Javadocs
 */
public abstract class Javadocs {
    /**
     * Link to Java API to use when generating Javadoc
     */
    public abstract Property<URI> getJavaApi();

    /**
     * Link to Groovy API to use when generating Javadoc
     */
    public abstract Property<URI> getGroovyApi();

    /**
     * The CSS file to style Javadocs with
     */

                    }
                });
            }
        });

        extension.javadocs(javadocs -> {
            javadocs.getJavadocCss().convention(extension.getSourceRoot().file("css/javadoc.css"));

            // TODO: destinationDirectory should be part of Javadoc

    }

    public void dslReference(Action<? super DslReference> action) {
        action.execute(dslReference);
    }

    public Javadocs getJavadocs() {
        return javadocs;
    }

    public void javadocs(Action<? super Javadocs> action) {
        action.execute(javadocs);
    }

    public KotlinDslReference getKotlinDslReference() {
        return kotlinDslReference;
    }

    "JdkObsolete", // Most of the checks are good, but we do not want to replace all LinkedLists without a good reason

    // NEVER
    "MissingSummary", // We have another mechanism to check Javadocs on public API
    "InjectOnConstructorOfAbstractClass", // We use abstract injection as a pattern
    "JavaxInjectOnAbstractMethod", // We use abstract injection as a pattern
    "JavaUtilDate", // We are fine with using Date
)

    }

    def "finds broken javadoc links with leading javadoc path component"() {
        given:
        sampleDoc << """
=== Invalid Javadoc Links

plugins {
    id("gradlebuild.build-logic.kotlin-dsl-gradle-plugin")
    id("gradlebuild.build-logic.groovy-dsl-gradle-plugin")
}

description = "Provides a plugin to generate Gradle's DSL reference, User Manual and Javadocs"

dependencies {
    implementation("gradlebuild:basics")
    implementation("gradlebuild:module-identity")

    implementation(project(":build-update-utils"))

    implementation("com.github.javaparser:javaparser-core")

            // DSL reference goes into dsl/
            task.from(extension.getDslReference().getRenderedDocumentation(), sub -> sub.into("dsl"));

            // Javadocs reference goes into javadoc/
            task.from(extension.getJavadocs().getRenderedDocumentation(), sub -> sub.into("javadoc"));

            // Dokka Kotlin DSL reference goes into kotlin-dsl/

            // TODO: This is coupled to extension.getJavadocs().getJavaApi()
            attributes.put("javadocReferenceUrl", "https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html");
            // TODO: This is coupled to extension.getJavadocs().getJavaApi()
            attributes.put("minJdkVersion", "8");

            attributes.put("antManual", "https://ant.apache.org/manual");

;&(src:org.gradle.||src:org.gradle.api..*||src:org.gradle.authentication..*||src:org.gradle.build..*||src:org.gradle.buildinit..*||src:org.gradle.caching..*||src:org.gradle.concurrent..*||src:org.gradle.deployment..*||src:org.gradle.external.javadoc..*||src:org.gradle.ide..*||src:org.gradle.ivy..*||src:org.gradle.jvm..*||src:org.gradle.language..*||src:org.gradle.maven..*||src:org.gradle.nativeplatform..*||src:org.gradle.normalization..*||src:org.gradle.platform..*||src:org.gradle.plugin.dev...

- [ ] Provide integration tests (under `<subproject>/src/integTest`) to verify changes from a user perspective.
- [ ] Provide unit tests (under `<subproject>/src/test`) to verify logic.
- [ ] Update User Guide, DSL Reference, and Javadoc for public-facing changes.
- [ ] Ensure that tests pass sanity check: `./gradlew sanityCheck`.
- [ ] Ensure that tests pass locally: `./gradlew <changed-subproject>:quickTest`.

### Reviewing cheatsheet