Fixed KdocComments

diktat-api/src/main/kotlin/com/saveourtool/diktat/DiktatRunnerFactory.kt

@@ -5,14 +5,20 @@ import com.saveourtool.diktat.api.DiktatBaselineFactory
 import com.saveourtool.diktat.api.DiktatProcessorListener
 import com.saveourtool.diktat.api.DiktatReporter
 import com.saveourtool.diktat.api.DiktatReporterFactory
+import com.saveourtool.diktat.api.DiktatRuleConfig
 import com.saveourtool.diktat.api.DiktatRuleConfigReader
+import com.saveourtool.diktat.api.DiktatRuleSet
 import com.saveourtool.diktat.api.DiktatRuleSetFactory
 import java.io.OutputStream
 import java.nio.file.Path
 
 /**
  * A factory to create [DiktatRunner]
  *
+ * @property diktatRuleConfigReader a reader for [DiktatRuleConfig]
+ * @property diktatRuleSetFactory a factory for [DiktatRuleSet]
+ * @property diktatProcessorFactory a factory for [DiktatProcessor]
+ * @property diktatBaselineFactory a factory for [DiktatBaseline]
  * @property diktatReporterFactory a factory for [DiktatReporter]
  */
 class DiktatRunnerFactory(

diktat-cli/src/main/kotlin/com/saveourtool/diktat/cli/DiktatProperties.kt

@@ -30,6 +30,9 @@ import kotlinx.cli.vararg
  * @property mode mode of `diktat`
  * @property reporterProviderId
  * @property output
+ * @property groupByFileInPlain
+ * @property colorNameInPlain
+ * @property logLevel
  * @property patterns
  */
 data class DiktatProperties(

diktat-common/src/main/kotlin/com/saveourtool/diktat/common/cli/CliArgument.kt

@@ -8,8 +8,10 @@ import kotlinx.serialization.Serializable
  * This class is used to serialize/deserialize json representation
  * that is used to store command line arguments
  * @property shortName short argument representation like -h
+ * @property helpDescr
  * @property longName long argument representation like --help
  * @property hasArgs indicates if option should have explicit argument
+ * @property isRequired
  */
 @Serializable
 data class CliArgument(

diktat-common/src/main/kotlin/com/saveourtool/diktat/common/config/rules/RulesConfigReader.kt

@@ -76,7 +76,7 @@ open class RulesConfigReader : AbstractConfigReader<List<RulesConfig>>() {
 /**
  * class returns the list of common configurations that we have read from a configuration map
  *
- * @param configuration map of common configuration
+ * @property configuration map of common configuration
  */
 data class CommonConfiguration(private val configuration: Map<String, String>?) {
     /**

diktat-dev-ksp/src/main/kotlin/com/saveourtool/diktat/ruleset/generation/EnumNamesSymbolProcessor.kt

@@ -11,6 +11,8 @@ import com.google.devtools.ksp.symbol.KSClassDeclaration
 
 /**
  * [SymbolProcessor] to generate a class with contacts for names from provided enum
+ *
+ * @property codeGenerator
  */
 class EnumNamesSymbolProcessor(
     private val codeGenerator: CodeGenerator,

diktat-gradle-plugin/src/main/kotlin/com/saveourtool/diktat/plugin/gradle/DiktatExtension.kt

@@ -9,6 +9,8 @@ import java.io.File
 
 /**
  * An extension to configure diktat in build.gradle(.kts) file
+ *
+ * @property patternSet
  */
 open class DiktatExtension(
     private val patternSet: PatternSet

diktat-gradle-plugin/src/main/kotlin/com/saveourtool/diktat/plugin/gradle/tasks/DiktatTaskBase.kt

@@ -33,6 +33,7 @@ import java.nio.file.Path
 /**
  * A base task to run `diktat`
  * @property extension
+ * @property inputs
  */
 @Suppress("WRONG_NEWLINES", "Deprecation")
 abstract class DiktatTaskBase(

diktat-ktlint-engine/src/main/kotlin/com/saveourtool/diktat/ktlint/DiktatReporterImpl.kt

@@ -8,6 +8,9 @@ import java.nio.file.Path
 
 /**
  * [DiktatReporter] using __KtLint__
+ *
+ * @property ktLintReporter
+ * @property sourceRootDir
  */
 class DiktatReporterImpl(
     private val ktLintReporter: ReporterV2,

diktat-ktlint-engine/src/main/kotlin/com/saveourtool/diktat/ktlint/ReporterV2Wrapper.kt

@@ -6,7 +6,7 @@ import com.pinterest.ktlint.cli.reporter.core.api.ReporterV2
 /**
  * Wrapper for [ReporterV2]
  *
- * @param reporterV2
+ * @property reporterV2
  */
 open class ReporterV2Wrapper(private val reporterV2: ReporterV2) : ReporterV2 {
     override fun beforeAll() = reporterV2.beforeAll()

diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/constants/Warnings.kt

@@ -13,6 +13,7 @@ import org.jetbrains.kotlin.com.intellij.lang.ASTNode
  * A [Warnings] entry contains rule name, warning message and is used in code check.
  * @property canBeAutoCorrected whether this inspection can automatically fix the code. Should be public to be able to use it in docs generator.
  * @property ruleId number of the inspection according to [diktat code style](https://github.com/saveourtool/diktat/blob/master/info/guide/diktat-coding-convention.md)
+ * @property warn description of the inspection
  */
 @Suppress(
     "ForbiddenComment",

diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter3/files/TopLevelOrderRule.kt

@@ -81,6 +81,8 @@ class TopLevelOrderRule(configRules: List<RulesConfig>) : DiktatRule(
 
     /**
      * Class containing different groups of properties in file
+     *
+     * @property properties
      */
     private data class Properties(private val properties: List<ASTNode>) : Elements {
         override fun sortElements(): MutableList<ASTNode> {
@@ -94,6 +96,11 @@ class TopLevelOrderRule(configRules: List<RulesConfig>) : DiktatRule(
 
     /**
      * Class containing different children in file
+     *
+     * @property properties
+     * @property typealiases
+     * @property functions
+     * @property classes
      */
     private data class Blocks(
         private val properties: List<ASTNode>,

diktat-rules/src/test/kotlin/com/saveourtool/diktat/ruleset/chapter2/KdocCommentsFixTest.kt

@@ -4,8 +4,8 @@ import com.saveourtool.diktat.ruleset.rules.chapter2.kdoc.KdocComments
 import com.saveourtool.diktat.util.FixTestBase
 
 import generated.WarningNames
-import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Tag
+import org.junit.jupiter.api.Tags
 import org.junit.jupiter.api.Test
 
 class KdocCommentsFixTest : FixTestBase("test/paragraph2/kdoc/", ::KdocComments) {
@@ -16,20 +16,25 @@ class KdocCommentsFixTest : FixTestBase("test/paragraph2/kdoc/", ::KdocComments)
     }
 
     @Test
-    @Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY)
+    @Tags(Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY), Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT), Tag(WarningNames.MISSING_KDOC_TOP_LEVEL))
+    fun `check fix without class kdoc`() {
+        fixAndCompare("ConstructorCommentNoKDocExpected.kt", "ConstructorCommentNoKDocTest.kt")
+    }
+
+    @Test
+    @Tags(Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY), Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT))
     fun `check fix with class kdoc`() {
         fixAndCompare("ConstructorCommentExpected.kt", "ConstructorCommentTest.kt")
     }
 
-    @Disabled("https://github.com/saveourtool/diktat/issues/1737")
     @Test
-    @Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY)
-    fun `check fix without class kdoc`() {
-        fixAndCompare("ConstructorCommentNoKDocExpected.kt", "ConstructorCommentNoKDocTest.kt")
+    @Tags(Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY), Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT))
+    fun `check fix with properties in class kdoc`() {
+        fixAndCompare("ConstructorCommentPropertiesExpected.kt", "ConstructorCommentPropertiesTest.kt")
     }
 
     @Test
-    @Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY)
+    @Tags(Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY), Tag(WarningNames.KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT))
     fun `should preserve newlines when moving comments from value parameters`() {
         fixAndCompare("ConstructorCommentNewlineExpected.kt", "ConstructorCommentNewlineTest.kt")
     }