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

Fixed KdocComments #1754

Merged
merged 30 commits into from
Oct 16, 2023
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
37edc00
Fixed KdocComments
DrAlexD Sep 28, 2023
fc88b09
Merge branch 'master' into feature/fix-kdoc-comments
DrAlexD Sep 28, 2023
c1ebe74
- fix
DrAlexD Sep 28, 2023
d5e31fa
Merge branch 'feature/fix-kdoc-comments' of https://github.com/DrAlex…
DrAlexD Sep 28, 2023
bdef44b
- fix
DrAlexD Sep 28, 2023
382736a
- fix
DrAlexD Sep 28, 2023
d01ba9e
- fixed case when @property text in class-KDoc didn't create for KDoc…
DrAlexD Oct 2, 2023
96e3c8f
- fix
DrAlexD Oct 2, 2023
96a271c
- fix
DrAlexD Oct 2, 2023
a10486b
- fix affected classes
DrAlexD Oct 2, 2023
88f429f
- fix affected classes
DrAlexD Oct 2, 2023
8c4d75c
Merge branch 'master' into feature/fix-kdoc-comments
DrAlexD Oct 2, 2023
27fb72f
Merge branch 'master' into feature/fix-kdoc-comments
DrAlexD Oct 9, 2023
7a85200
Merge branch 'master' into feature/fix-kdoc-comments
DrAlexD Oct 9, 2023
19e59ff
- added non-fixed warning `KDOC_EXTRA_PROPERTY` for redundant `@param…
DrAlexD Oct 9, 2023
eec619c
Merge branch 'feature/fix-kdoc-comments' of https://github.com/DrAlex…
DrAlexD Oct 9, 2023
77fc1ba
- fix
DrAlexD Oct 9, 2023
2e180cb
- fix
DrAlexD Oct 9, 2023
67d18fa
- fix
DrAlexD Oct 9, 2023
43fadfc
- fix
DrAlexD Oct 10, 2023
d16ad71
- fix
DrAlexD Oct 10, 2023
78d8012
- fix
DrAlexD Oct 10, 2023
62c5bd3
- added configuration for `@param` tags creation: `isParamTagsForPara…
DrAlexD Oct 11, 2023
91016b9
- fix
DrAlexD Oct 11, 2023
b7ba451
- fix
DrAlexD Oct 11, 2023
5cfbb44
- fix docs
DrAlexD Oct 12, 2023
62bf445
- fix docs
DrAlexD Oct 12, 2023
e986c4d
- fix docs
DrAlexD Oct 16, 2023
275e45c
- fix
DrAlexD Oct 16, 2023
b03af2c
Merge branch 'master' into feature/fix-kdoc-comments
DrAlexD Oct 16, 2023
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
Prev Previous commit
Next Next commit
- fix affected classes
  • Loading branch information
DrAlexD committed Oct 2, 2023
commit 88f429f2d2e3a89ee0ae54d1446006b74c493a4b
Original file line number Diff line number Diff line change
@@ -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]
nulls marked this conversation as resolved.
Show resolved Hide resolved
* @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(
Original file line number Diff line number Diff line change
@@ -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(
Original file line number Diff line number Diff line change
@@ -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(
Original file line number Diff line number Diff line change
@@ -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>?) {
/**
Original file line number Diff line number Diff line change
@@ -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,
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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(
Original file line number Diff line number Diff line change
@@ -8,6 +8,9 @@ import java.nio.file.Path

/**
* [DiktatReporter] using __KtLint__
*
* @property ktLintReporter
* @property sourceRootDir
*/
class DiktatReporterImpl(
private val ktLintReporter: ReporterV2,
Original file line number Diff line number Diff line change
@@ -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()
Original file line number Diff line number Diff line change
@@ -14,6 +14,9 @@ import kotlinx.coroutines.runBlocking

/**
* Class that wraps shell [command] and can execute it
*
* @property command
* @property ioDispatcher
*/
class LocalCommandExecutor internal constructor(
private val command: String,
Original file line number Diff line number Diff line change
@@ -11,6 +11,10 @@ import java.io.File

/**
* A class that is capable of comparing files content
*
* @property fileName
* @property expectedResult
* @property actualResult
*/
class FileComparator(
private val fileName: String,
Original file line number Diff line number Diff line change
@@ -17,6 +17,8 @@ import kotlin.system.exitProcess

/**
* A class that runs tests based on configuration
*
* @property argReader
*/
@Suppress("ForbiddenComment")
class TestProcessingFactory(private val argReader: TestArgumentsReader) {