Use plugins DSL in Javadoc code snippets

dmvk · Apr 20, 2020 · 4167c07 · 4167c07
1 parent 1fad433
commit 4167c07
Show file tree

Hide file tree

Showing 48 changed files with 271 additions and 112 deletions.
diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ConfigurationContainer.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ConfigurationContainer.java
@@ -49,7 +49,9 @@
  * An example showing how to refer to a given configuration by name
  * in order to get hold of all dependencies (e.g. jars, but only)
  * <pre class='autoTested'>
- *   apply plugin: 'java' //so that I can use 'implementation', 'compileClasspath' configuration
+ *   plugins {
+ *       id 'java' //so that I can use 'implementation', 'compileClasspath' configuration
+ *   }
  *
  *   dependencies {
  *       implementation 'org.slf4j:slf4j-api:1.7.26'
@@ -65,7 +67,9 @@
  *
  * An example showing how to declare and configure configurations
  * <pre class='autoTested'>
- * apply plugin: 'java' //so that I can use 'implementation', 'testImplementation' configurations
+ * plugins {
+ *     id 'java' // so that I can use 'implementation', 'testImplementation' configurations
+ * }
  *
  * configurations {
  *   //adding a configuration:

diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ModuleDependency.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ModuleDependency.java
@@ -54,7 +54,9 @@ public interface ModuleDependency extends Dependency, HasConfigurableAttributes<
      * then consider using forced versions' feature: {@link ResolutionStrategy#force(Object...)}.
      *
      * <pre class='autoTested'>
-     * apply plugin: 'java' //so that I can declare 'implementation' dependencies
+     * plugins {
+     *     id 'java' // so that I can declare 'implementation' dependencies
+     * }
      *
      * dependencies {
      *   implementation('org.hibernate:hibernate:3.1') {

diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ResolutionStrategy.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/ResolutionStrategy.java
@@ -28,7 +28,9 @@
  * <p>
  * Examples:
  * <pre class='autoTested'>
- * apply plugin: 'java' //so that there are some configurations
+ * plugins {
+ *     id 'java' // so that there are some configurations
+ * }
  *
  * configurations.all {
  *   resolutionStrategy {
@@ -70,7 +72,9 @@ public interface ResolutionStrategy {
      * The check includes both first level and transitive dependencies. See example below:
      *
      * <pre class='autoTested'>
-     * apply plugin: 'java' //so that there are some configurations
+     * plugins {
+     *     id 'java' // so that there are some configurations
+     * }
      *
      * configurations.all {
      *   resolutionStrategy.failOnVersionConflict()
@@ -129,7 +133,9 @@ public interface ResolutionStrategy {
      * This applies to both first level and transitive dependencies. See example below:
      *
      * <pre class='autoTested'>
-     * apply plugin: 'java' //so that there are some configurations
+     * plugins {
+     *     id 'java' // so that there are some configurations
+     * }
      *
      * configurations.all {
      *   resolutionStrategy.preferProjectModules()
@@ -191,7 +197,9 @@ public interface ResolutionStrategy {
      * </ul>
      * Example:
      * <pre class='autoTested'>
-     * apply plugin: 'java' //so that there are some configurations
+     * plugins {
+     *     id 'java' // so that there are some configurations
+     * }
      *
      * configurations.all {
      *   resolutionStrategy.force 'asm:asm-all:3.3.1', 'commons-io:commons-io:1.4'
@@ -212,7 +220,9 @@ public interface ResolutionStrategy {
      * <p>
      * Example:
      * <pre class='autoTested'>
-     * apply plugin: 'java' //so that there are some configurations
+     * plugins {
+     *     id 'java' // so that there are some configurations
+     * }
      *
      * configurations.all {
      *   resolutionStrategy.forcedModules = ['asm:asm-all:3.3.1', 'commons-io:commons-io:1.4']

diff --git a/...rojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.java b/...rojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/ComponentMetadataHandler.java
@@ -33,7 +33,9 @@
  *
  * <p>Example shows a basic way of removing certain transitive dependencies from one of our dependencies.</p>
  * <pre class='autoTested'>
- * apply plugin: 'java'
+ * plugins {
+ *     id 'java'
+ * }
  *
  * repositories {
  *     mavenCentral()

diff --git a/subprojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/DependencyHandler.java b/subprojects/core-api/src/main/java/org/gradle/api/artifacts/dsl/DependencyHandler.java
@@ -45,8 +45,9 @@
  *
  * <p>Example shows a basic way of declaring dependencies.
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * //so that we can use 'implementation', 'testImplementation' for dependencies
+ * plugins {
+ *     id 'java' // so that we can use 'implementation', 'testImplementation' for dependencies
+ * }
  *
  * dependencies {
  *   //for dependencies found in artifact repositories you can use
@@ -87,7 +88,9 @@
  * </ul>
  *
  * <pre class='autoTestedWithDeprecations'>
- * apply plugin: 'java' //so that I can declare 'implementation' dependencies
+ * plugins {
+ *     id 'java' // so that I can declare 'implementation' dependencies
+ * }
  *
  * dependencies {
  *   implementation('org.hibernate:hibernate:3.1') {
@@ -112,7 +115,9 @@
  * </ul>
  *
  * <pre class='autoTested'>
- * apply plugin: 'java' //so that I can declare 'implementation' dependencies
+ * plugins {
+ *     id 'java' // so that I can declare 'implementation' dependencies
+ * }
  *
  * dependencies {
  *   //configuring dependency to specific configuration of the module
@@ -161,8 +166,9 @@
  * org.gradle.api.artifacts.ExternalModuleDependency}.</p>
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * //so that we can use 'implementation', 'testImplementation' for dependencies
+ * plugins {
+ *     id 'java' // so that we can use 'implementation', 'testImplementation' for dependencies
+ * }
  *
  * dependencies {
  *   //for dependencies found in artifact repositories you can use
@@ -195,8 +201,9 @@
  * <code><i>configurationName</i> files('a file')</code>
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * //so that we can use 'implementation', 'testImplementation' for dependencies
+ * plugins {
+ *     id 'java' // so that we can use 'implementation', 'testImplementation' for dependencies
+ * }
  *
  * dependencies {
  *   //declaring arbitrary files as dependencies
@@ -225,8 +232,10 @@
  *
  * <pre class='autoTested'>
  * //Our Gradle plugin is written in groovy
- * apply plugin: 'groovy'
- * //now we can use the 'implementation' configuration for declaring dependencies
+ * plugins {
+ *     id 'groovy'
+ * }
+ * // now we can use the 'implementation' configuration for declaring dependencies
  *
  * dependencies {
  *   //we will use the Groovy version that ships with Gradle:

diff --git a/...ojects/core-api/src/main/java/org/gradle/api/artifacts/query/ArtifactResolutionQuery.java b/...ojects/core-api/src/main/java/org/gradle/api/artifacts/query/ArtifactResolutionQuery.java
@@ -26,7 +26,9 @@
  * A builder to construct a query that can resolve selected software artifacts of the specified components.
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
+ * plugins {
+ *     id 'java'
+ * }
  *
  * task resolveCompileSources {
  *     doLast {

diff --git a/subprojects/core/src/main/java/org/gradle/api/tasks/JavaExec.java b/subprojects/core/src/main/java/org/gradle/api/tasks/JavaExec.java
@@ -58,7 +58,9 @@
  * Similar to {@link org.gradle.api.tasks.Exec}, but starts a JVM with the given classpath and application class.
  * </p>
  * <pre class='autoTested'>
- * apply plugin: 'java'
+ * plugins {
+ *     id 'java'
+ * }
  *
  * task runApp(type: JavaExec) {
  *   classpath = sourceSets.main.runtimeClasspath

diff --git a/subprojects/ide-native/src/main/java/org/gradle/ide/visualstudio/VisualStudioProject.java b/subprojects/ide-native/src/main/java/org/gradle/ide/visualstudio/VisualStudioProject.java
@@ -32,8 +32,11 @@
  * The content and location of the generate project file can be modified by the supplied methods:
  *
  * <pre class='autoTested'>
- *  apply plugin: "cpp"
- *  apply plugin: "visual-studio"
+ *  plugins {
+ *      id 'cpp'
+ *      id 'visual-studio'
+ *  }
+ *
  *  model {
  *      visualStudio {
  *          projects.all {

diff --git a/subprojects/ide-native/src/main/java/org/gradle/ide/visualstudio/VisualStudioSolution.java b/subprojects/ide-native/src/main/java/org/gradle/ide/visualstudio/VisualStudioSolution.java
@@ -33,7 +33,10 @@
  * The content and location of the generate solution file can be modified by the supplied methods:
  *
  * <pre class='autoTested'>
- *  apply plugin: "visual-studio"
+ *  plugins {
+ *      id 'visual-studio'
+ *  }
+ *
  *  model {
  *      visualStudio {
  *          solution {

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseClasspath.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseClasspath.java
@@ -54,8 +54,10 @@
  * if the defaults don't match your needs.
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * configurations {
  *   provided
@@ -95,8 +97,10 @@
  * Examples of advanced configuration:
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * eclipse {
  *   classpath {

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseJdt.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseJdt.java
@@ -28,8 +28,10 @@
  * Enables fine-tuning jdt details of the Eclipse plugin
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * eclipse {
  *   jdt {

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseModel.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseModel.java
@@ -38,9 +38,11 @@
  * First point of entry for customizing Eclipse project generation.
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
- * apply plugin: 'eclipse-wtp' //for web projects only
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ *     id 'eclipse-wtp' // for web projects only
+ * }
  *
  * eclipse {
  *   pathVariables 'GRADLE_HOME': file('/best/software/gradle'), 'TOMCAT_HOME': file('../tomcat')

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseProject.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseProject.java
@@ -41,8 +41,10 @@
  * Bear in mind that usually you don't have configure eclipse project directly because Gradle configures it for free!
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * eclipse {
  *   project {
@@ -95,8 +97,10 @@
  * Examples of advanced configuration:
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * eclipse {
  *   project {

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtp.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtp.java
@@ -33,8 +33,10 @@
  * More interesting examples you will find in docs for {@link EclipseWtpComponent} and {@link EclipseWtpFacet}
  *
  * <pre class='autoTested'>
- * apply plugin: 'war' //or 'ear' or 'java'
- * apply plugin: 'eclipse-wtp'
+ * plugins {
+ *     id 'war' // or 'ear' or 'java'
+ *     id 'eclipse-wtp'
+ * }
  *
  * eclipse {
  *

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtpComponent.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtpComponent.java
@@ -46,8 +46,10 @@
  * Bear in mind that usually you don't have to configure them directly because Gradle configures it for free!
  *
  * <pre class='autoTested'>
- * apply plugin: 'war' //or 'ear' or 'java'
- * apply plugin: 'eclipse-wtp'
+ * plugins {
+ *     id 'war' // or 'ear' or 'java'
+ *     id 'eclipse-wtp'
+ * }
  *
  * configurations {
  *   someInterestingConfiguration
@@ -100,8 +102,10 @@
  * Examples of advanced configuration:
  *
  * <pre class='autoTested'>
- * apply plugin: 'war'
- * apply plugin: 'eclipse-wtp'
+ * plugins {
+ *     id 'war'
+ *     id 'eclipse-wtp'
+ * }
  *
  * eclipse {
  *

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtpFacet.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/EclipseWtpFacet.java
@@ -35,8 +35,10 @@
  * Advanced configuration closures beforeMerged and whenMerged receive {@link WtpFacet} object as parameter.
  *
  * <pre class='autoTested'>
- * apply plugin: 'war' //or 'ear' or 'java'
- * apply plugin: 'eclipse-wtp'
+ * plugins {
+ *     id 'war' // or 'ear' or 'java'
+ *     id 'eclipse-wtp'
+ * }
  *
  * eclipse {
  *   wtp {

diff --git a/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/ResourceFilter.java b/subprojects/ide/src/main/java/org/gradle/plugins/ide/eclipse/model/ResourceFilter.java
@@ -26,8 +26,10 @@
  * or both.  The following example excludes the 'node_modules' folder.
  *
  * <pre class='autoTested'>
- * apply plugin: 'java'
- * apply plugin: 'eclipse'
+ * plugins {
+ *     id 'java'
+ *     id 'eclipse'
+ * }
  *
  * eclipse {
  *   project {