TaskProvider<Javadoc> javadocAll = tasks.register("javadocAll", Javadoc.class, task -> {
            task.setGroup("documentation");
            task.setDescription("Generate Javadocs for all API classes");

            task.setTitle("Gradle API " + version);

            Javadocs javadocs = extension.getJavadocs();

            // TODO: This should be part of Javadoc task

    <checker.version>3.43.0</checker.version>
    <errorprone.version>2.28.0</errorprone.version>
    <j2objc.version>3.0.0</j2objc.version>
    <javac.version>9+181-r4173-1</javac.version>
    <!-- Empty for all JDKs but 9-12 -->
    <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>
    <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>

    <checker.version>3.43.0</checker.version>
    <errorprone.version>2.28.0</errorprone.version>
    <j2objc.version>3.0.0</j2objc.version>
    <javac.version>9+181-r4173-1</javac.version>
    <!-- Empty for all JDKs but 9-12 -->
    <maven-javadoc-plugin.additionalJOptions></maven-javadoc-plugin.additionalJOptions>
    <project.build.outputTimestamp>2024-01-02T00:00:00Z</project.build.outputTimestamp>

# Gradle Javadoc Style Guide

## 1.1 Formatting

### 1.1.1 General form

The basic formatting of Javadoc blocks is as seen in this example:

```java
/**
 * Returns an Image object that can then be painted on the screen.
 * <p>
 * The url argument must specify an absolute {@link URL}. 
 * The name argument is a specifier that is relative to the url argument.
 * This method always returns immediately, whether or not the image exists. 
 *

*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<javadoc>>>         | <<<javadoc>>> | <<<jar>>>  | java      | classes               |                       |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+

*--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+
| <<<javadoc>>>      | <<<javadoc>>> | <<<jar>>>  | <= type>   | java      | <<<true>>>          |                       |

                new DefaultType(
                        Type.JAR, Language.JAVA_FAMILY, "jar", null, false, JavaPathType.CLASSES, JavaPathType.MODULES),
                new DefaultType(Type.JAVADOC, Language.JAVA_FAMILY, "jar", "javadoc", false, JavaPathType.CLASSES),
                new DefaultType(Type.JAVA_SOURCE, Language.JAVA_FAMILY, "jar", "sources", false),
                new DefaultType(
                        Type.TEST_JAR,

import java.util.Collections;
import java.util.List;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;

/** See newDirectExecutorService javadoc for behavioral notes. */
@J2ktIncompatible // Emulated
@GwtIncompatible
@ElementTypesAreNonnullByDefault
final class DirectExecutorService extends AbstractListeningExecutorService {

                new DefaultType(
                        Type.JAR, Language.JAVA_FAMILY, "jar", null, false, JavaPathType.CLASSES, JavaPathType.MODULES),
                new DefaultType(Type.JAVADOC, Language.JAVA_FAMILY, "jar", "javadoc", false, JavaPathType.CLASSES),
                new DefaultType(Type.JAVA_SOURCE, Language.JAVA_FAMILY, "jar", "sources", false),
                new DefaultType(
                        Type.TEST_JAR,

        if (signArtifacts) {
            signing.sign(this)
        }
    }
}

fun configureJavadocVariant() {
    java {
        withJavadocJar()
    }
    tasks.named<Javadoc>("javadoc") {
        // See GradleJavadocsPlugin.generateJavadocs() and the javadocsAll task