Minor DevPublishPluginExtension kdoc updates

adamko-dev · Jul 13, 2024 · bda334c · bda334c
1 parent 16c2b4a
commit bda334c
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/main/kotlin/DevPublishPluginExtension.kt b/src/main/kotlin/DevPublishPluginExtension.kt
@@ -4,15 +4,15 @@ import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
 import org.gradle.api.file.DirectoryProperty
 
 /**
- * Settings for controlling the behaviour of [DevPublishPlugin] and tasks.
+ * Settings for controlling the behaviour of [DevPublishPlugin] and its tasks.
  */
 abstract class DevPublishPluginExtension
 @DevPublishInternalApi constructor() {
 
   /**
    * Location of the file-based test Maven repository.
    *
-   * The repository is specific per subproject and should not be shared between subprojects.
+   * The repository is specific per subproject and should not be referenced by other subprojects.
    *
    * This property should be passed into tests and provided as a Maven repository.
    */
@@ -21,15 +21,15 @@ abstract class DevPublishPluginExtension
   /**
    * Location of temporary Maven repository, that will be used to populate [devMavenRepo].
    *
-   * This value should not typically be configured or used.
+   * This value is intended for internal use and should not typically be configured in build scripts.
    */
   @DevPublishInternalApi
   abstract val stagingDevMavenRepo: DirectoryProperty
 
   /**
    * Temporary storage of individual publications.
    *
-   * This value should not typically be configured or used.
+   * This value is intended for internal use and should not typically be configured in build scripts.
    */
   @DevPublishInternalApi
   abstract val publicationsStore: DirectoryProperty
@@ -39,7 +39,7 @@ abstract class DevPublishPluginExtension
    * [dev.adamko.gradle.dev_publish.data.PublicationData]
    * checksums used to determine if a publication task is up-to-date.
    *
-   * This value should not typically be configured or used.
+   * This value is intended for internal use and should not typically be configured in build scripts.
    */
   @DevPublishInternalApi
   abstract val checksumsStore: DirectoryProperty