Skip to content

Commit

Permalink
kdoc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
YannCebron committed Sep 11, 2024
1 parent c93bfac commit bb5ff60
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class IntelliJPlatformRepositoriesHelper(
*
* @param name The name of the repository.
* @param url The URL of the repository.
* @param pattern The pattern used for artifact resolution. Defaults to an empty string.
* @param patterns The patterns used for artifact resolution. Defaults to an empty list.
* @param action The action to be performed on the repository. Defaults to an empty action.
*/
internal fun createIvyRepository(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ data class IvyModule(
* As we remove the drive letter, we later have to guess which drive the artifact belongs to by iterating over A:/, B:/, C:/, ...
* but that's not a huge problem.
*
* @see IntelliJPlatformRepositoriesExtension.jetbrainsCdn
* @see IntelliJPlatformRepositoriesExtension.jetbrainsIdeInstallers
*/
internal fun Path.toIvyArtifact() = IvyModule.Artifact(
name = invariantSeparatorsPathString.replaceFirst(Regex("^[a-zA-Z]:/"), "/"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,9 @@ fun ProductInfo.validateSupportedVersion() {
}

/**
* Finds the [ProductInfo.Launch] object for the given architecture and OS.
* Finds the [ProductInfo.Launch] object for the given architecture and current OS.
*
* @param architecture The architecture of the target system.
* @param os The operating system of the target system. By default, it refers to [OperatingSystem.current].
* @return The launch configuration for the specified architecture.
* @throws GradleException If the specified architecture is not supported.
* @throws IllegalArgumentException If the launch information for the current OS and architecture is not found.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ import kotlin.io.path.nameWithoutExtension
* This task runs against the IntelliJ Platform and plugins specified in project dependencies.
* To register a customized task, use [IntelliJPlatformTestingExtension.testIdePerformance] instead.
*
* The [TestIdePerformanceTask] task extends the [RunIdeBase] task, so all configuration attributes of [JavaExec] and [RunIdeTask] tasks can be used in the [TestIdePerformanceTask] as well.
* The [TestIdePerformanceTask] task extends the [JavaExec] task and implements [RunnableIdeAware],
* so all configuration attributes of [JavaExec] and [RunIdeTask] tasks can be used in the [TestIdePerformanceTask] as well.
* See [RunIdeTask] task for more details.
*
* Currently, the task is under adaptation; more documentation will be added in the future.
Expand Down Expand Up @@ -127,7 +128,8 @@ abstract class TestIdePerformanceTask : JavaExec(), RunnableIdeAware, TestableAw
companion object : Registrable {

internal val configuration: TestIdePerformanceTask.() -> Unit = {
val prepareTestIdePerformanceSandboxTaskProvider = project.tasks.named<PrepareSandboxTask>(Tasks.PREPARE_TEST_IDE_PERFORMANCE_SANDBOX)
val prepareTestIdePerformanceSandboxTaskProvider =
project.tasks.named<PrepareSandboxTask>(Tasks.PREPARE_TEST_IDE_PERFORMANCE_SANDBOX)
applySandboxFrom(prepareTestIdePerformanceSandboxTaskProvider)

// artifactsDirectory.convention(extension.type.flatMap { type ->
Expand Down Expand Up @@ -163,7 +165,11 @@ abstract class TestIdePerformanceTask : JavaExec(), RunnableIdeAware, TestableAw
}

override fun register(project: Project) =
project.registerTask<TestIdePerformanceTask>(Tasks.TEST_IDE_PERFORMANCE, configureWithType = false, configuration = configuration)
project.registerTask<TestIdePerformanceTask>(
Tasks.TEST_IDE_PERFORMANCE,
configureWithType = false,
configuration = configuration
)
}

// private fun resolveLatestPluginUpdate(pluginId: String, buildNumber: String, channel: String = "") =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ abstract class VerifyPluginTask : JavaExec(), RuntimeAware, PluginVerifierAware
/**
* Determines if the operation is running in offline mode.
*
* Default value: [StartParameter.offline]
* Default value: [org.gradle.StartParameter.offline]
*
* @see StartParameter
* @see org.gradle.StartParameter
* @see <a href="https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_execution_options">Command Line Execution options</a>
*/
@get:Internal
Expand Down

0 comments on commit bb5ff60

Please sign in to comment.