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(projects.buildUpdateUtils)

    implementation(buildLibs.gradleGuidesPlugin)

            // 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/

                String errMsg = "Missing Javadoc file for " + link + " in " + sourceFile.getName();
                if (link.startsWith("javadoc")) {
                    errMsg += " (You may need to remove the leading `javadoc` path component)";
                }
                errorsForFile.add(new Error(lineNumber, line, errMsg));
            }
            // TODO: Also parse the HTML in the javadoc file to check if the specific method is present

          "daemon-protocol",
          "daemon-server-worker",
          "functional",
          "internal-instrumentation-api",
          "java-api-extractor",
          "java-compiler-plugin",
          "javadoc",
          "kotlin-dsl-integ-tests",
          "kotlin-dsl-plugins",
          "normalization-java"
        ],
        "parallelizationMethod": {
          "name": "TestDistribution"
        }
      },

    <!-- These packages are duplicated in javadoc and groovydoc-worker, don't require a package-info.java in each place -->
    <suppress checks="JavadocPackage"
              files=".*[/\\]platforms[/\\]jvm[/\\]groovydoc-worker[/\\]src[/\\]main[/\\]java[/\\]org[/\\]gradle[/\\]api[/\\]tasks[/\\]javadoc[/\\][^/\\]+"/>

    <!-- Don't require api docs for projects only used internally -->

            attributes.put("doctype", "book");
            attributes.put("imagesdir", "img");
            attributes.put("nofooter", true);
            attributes.put("javadocPath", "../javadoc");
            attributes.put("sectanchors", true);
            attributes.put("sectlinks", true);
            attributes.put("linkattrs", true);
            attributes.put("reproducible", "");

      # - 11 (sometimes) to *download* to support anyone who runs JDiff or our Gradle integration tests (including our doc snapshots and our Java 11 CI test run) but not to use directly
      # - 25 for running Javadoc and javac (to help people who build Guava locally and might not use a recent JDK to run Maven)
      - name: 'Set up JDKs'
        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
        with:

If you want to run a single test, you'll need to pass multiple flags because
Guava is a multi-module project. For performance reasons, you may also wish to
skip generating Javadoc. For example:

```shell
./mvnw clean install -Dtest=FinalizableReferenceQueueTest -DfailIfNoTests=false -Dmaven.javadoc.skip
```

(Our benchmarks, however, are
[not set up to run easily externally][benchmarks-run].)

# https://squidfunk.github.io/mkdocs-material/
# It requires Python to run.
# Install the packages with the following command:
# pip install mkdocs mkdocs-material mkdocs-redirects

set -ex

# Test generating the javadoc jars
./gradlew publishToMavenLocal -DRELEASE_SIGNING_ENABLED=false -PokhttpDokka=true

# Generate the API docs
./gradlew dokkaGeneratePublicationHtml -PokhttpDokka=true

mv ./build/dokka/html docs/5.x

* For error messages related changes, follow the [ErrorMessages Guide](contributing/ErrorMessages.md).
* Add Javadoc for new methods and classes, following the [Javadoc Style Guide](contributing/JavadocStyleGuide.md). Javadoc is *required* for new public, top-level types.
* For new features, the feature should be mentioned in the [Release Notes](platforms/documentation/docs/src/docs/release/notes.md).