Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor DevPublishPluginExtension kdoc updates #34

Merged
merged 1 commit into from
Jul 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/main/kotlin/DevPublishPluginExtension.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading