# its own file.

on:
  - pr_created
  - commit
  - comment_added

automations:

  javadoc_on_new_files:
    # Triggered for new Java files that lack Javadoc content.
    if:

      - {{ ('javadoc_on_new_files' | isEnabledAutomation(pr)) }}
      - {{ is.java and is.new }}
      - {{ source.diff.files | matchDiffLines(regex=r/\/*\*([\s\S]*?)\//) | nope }}
    run:

void _dont_implement_Matcher___instead_extend_BaseMatcher_() Deprecated. Description copied from interface: Matcher This method simply acts a friendly reminder not to implement Matcher directly and instead extend BaseMatcher. It's easy to ignore JavaDoc, but a bit harder to ignore compile errors . Specified by: _dont_implement_Matcher___instead_extend_BaseMatcher_ in interface Matcher<T> See Also: Matcher._dont_implement_Matcher___instead_extend_BaseMatcher_() describeMismatch public void descri...

Guillaume Nodet <******@****.***> 1664700085 +0200

Tamas Cservenak <******@****.***> 1703012935 +0100

Guillaume Nodet <******@****.***> 1664700085 +0200

        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

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

    }

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

 with its <<<DefaultToolchainManager>>> implementation ({{{./xref/org/apache/maven/toolchain/DefaultToolchainManager.html}source}}),
 to get selected <<<Toolchain>>> ({{{./apidocs/org/apache/maven/toolchain/Toolchain.html}javadoc}}) instance,

 * internal <<<ToolchainManagerPrivate>>> component ({{{./apidocs/org/apache/maven/toolchain/ToolchainManagerPrivate.html}javadoc}})

            <offlineLink>
              <url>https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.1/</url>
              <location>${project.basedir}/javadoc-link/jsr305</location>
            </offlineLink>
            <offlineLink>
              <url>https://static.javadoc.io/com.google.j2objc/j2objc-annotations/1.1/</url>
              <location>${project.basedir}/javadoc-link/j2objc-annotations</location>
            </offlineLink>