== Adding API documentation

The `java-library` plugin has built-in support for Java's API documentation tool via the `javadoc` task.

The code generated by the Build Init plugin already placed a comment on the `${sourceFile.raw}` file.
Replace `/*` in the comment by `/**` so that it becomes `javadoc` markup:

.src/main/${languageLC.raw}/${sourceFile.raw}
[source,java]
----
/**
 * This java source file was generated by the Gradle 'init' task.
 */

    * FastAPI provides more features on top of Starlette. Features that you almost always need when building APIs, like data validation and serialization. And by using it, you get automatic documentation for free (the automatic documentation doesn't even add overhead to running applications, it is generated on startup).

    /**
     * Provides or requires a platform
     */
    JvmEcosystemAttributesDetails platform();

    /**
     * Provides or requires documentation
     * @param docsType the documentation type (javadoc, sources, ...)
     */
    JvmEcosystemAttributesDetails documentation(String docsType);

    /**
     * Provides or requires an API
     */
    JvmEcosystemAttributesDetails apiUsage();

    /**

                    withVariantReselection()
                    attributes {
                        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category, Category.DOCUMENTATION))
                        attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling, Bundling.EXTERNAL))
                        attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named(DocsType, DocsType.SOURCES))

 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.launcher.daemon.client;

import org.gradle.internal.deprecation.Documentation;
import org.gradle.internal.exceptions.DefaultMultiCauseException;
import org.gradle.internal.exceptions.ResolutionProvider;

import java.util.Collections;
import java.util.List;

    minimumSupportedMinor = "7.3"
    propertiesFile = layout.projectDirectory.file("gradle/dependency-management/agp-versions.properties")
    compatibilityDocFile = layout.projectDirectory.file("platforms/documentation/docs/src/docs/userguide/releases/compatibility.adoc")
}

tasks.register<UpdateKotlinVersions>("updateKotlinVersions") {
    comment = " Generated - Update by running `./gradlew updateKotlinVersions`"

public abstract class ReleaseNotes {
    /**
     * The source markdown file for the release notes.
     */
    public abstract RegularFileProperty getMarkdownFile();

    /**
     * The base CSS file used by all documentation.
     */
    public abstract RegularFileProperty getBaseCssFile();

    /**
     * The release notes specific CSS file
     */
    public abstract RegularFileProperty getReleaseNotesCssFile();

    /**

And those Python files are included/injected in the documentation when generating the site.

### Docs for tests

Most of the tests actually run against the example source files in the documentation.

This helps to make sure that:

* The documentation is up-to-date.
* The documentation examples can be run as is.
* Most of the features are covered by the documentation, ensured by test coverage.

import java.util.List;

import static org.gradle.util.internal.GUtil.isTrue;

/**
 * <p>Generates HTML API documentation for Java classes.</p>
 * <p>
 * If you create your own Javadoc tasks remember to specify the 'source' property!
 * Without source the Javadoc task will not create any documentation. Example:
 * <pre class='autoTested'>
 * plugins {
 *     id 'java'
 * }
 *
 * task myJavadocs(type: Javadoc) {

                }

                @Override
                public void execute(ComponentMetadataContext componentMetadataContext) {
                    Category category = objectFactory.named(Category.class, Category.DOCUMENTATION);
                    DocsType docsType = objectFactory.named(DocsType.class, "my-classifier");

                    ModuleVersionIdentifier id = componentMetadataContext.getDetails().getId();