style: fix the documentation of enums and companions

DanySK · Sep 21, 2024 · 0875572 · 0875572
1 parent 21d24ff
commit 0875572
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 5 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -22,7 +22,7 @@ dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 gitSemVer = "org.danilopianini.git-sensitive-semantic-versioning:3.1.7"
 gradlePluginPublish = "com.gradle.plugin-publish:1.3.0"
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
-kotlin-qa = "org.danilopianini.gradle-kotlin-qa:0.66.1"
+kotlin-qa = "org.danilopianini.gradle-kotlin-qa:0.67.2"
 multiJvmTesting = "org.danilopianini.multi-jvm-test-plugin:1.2.7"
 nexus-publish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexus-publish" }
 publishOnCentral = "org.danilopianini.publish-on-central:5.1.7"

diff --git a/src/main/kotlin/org/danilopianini/gradle/mavencentral/DocStyle.kt b/src/main/kotlin/org/danilopianini/gradle/mavencentral/DocStyle.kt
@@ -4,5 +4,23 @@ package org.danilopianini.gradle.mavencentral
  * Admissible type of styles used by Dokka to generate documentation from KDoc.
  */
 enum class DocStyle {
-    GFM, HTML, JAVADOC, JEKYLL
+    /**
+     * GitHub-Flavored Markdown.
+     */
+    GFM,
+
+    /**
+     * HTML.
+     */
+    HTML,
+
+    /**
+     * Classic Javadoc format.
+     */
+    JAVADOC,
+
+    /**
+     * Jekyll-rb.
+     */
+    JEKYLL,
 }
diff --git a/src/main/kotlin/org/danilopianini/gradle/mavencentral/NexusStatefulOperation.kt b/src/main/kotlin/org/danilopianini/gradle/mavencentral/NexusStatefulOperation.kt
@@ -128,7 +128,7 @@ data class NexusStatefulOperation(
         project.logger.lifecycle("Requested drop for repository {} ", repoId)
     }
 
-    companion object {
+    private companion object {
         private const val retryInterval: Long = 10
     }
 }
diff --git a/src/main/kotlin/org/danilopianini/gradle/mavencentral/PublishOnCentral.kt b/src/main/kotlin/org/danilopianini/gradle/mavencentral/PublishOnCentral.kt
@@ -28,7 +28,8 @@ import org.gradle.plugins.signing.SigningPlugin
  * A Plugin configuring the project for publishing on Maven Central.
  */
 class PublishOnCentral : Plugin<Project> {
-    companion object {
+
+    private companion object {
         /**
          * The name of the publication to be created.
          */

diff --git a/src/main/kotlin/org/danilopianini/gradle/mavencentral/PublishOnCentralExtension.kt b/src/main/kotlin/org/danilopianini/gradle/mavencentral/PublishOnCentralExtension.kt
@@ -119,7 +119,7 @@ open class PublishOnCentralExtension(val project: Project) {
         apply(configurator)
     }
 
-    companion object {
+    private companion object {
 
         private val extractName = Regex(""".*://(?:\w+\.)*(\w+)\.\w+(?:/.*)?""")
 

diff --git a/src/main/kotlin/org/danilopianini/gradle/mavencentral/Repository.kt b/src/main/kotlin/org/danilopianini/gradle/mavencentral/Repository.kt
@@ -29,6 +29,9 @@ data class Repository(
 
     override fun toString() = "$name at $url"
 
+    /**
+     * Constants and utility functions.
+     */
     companion object {
 
         /**