saveourtool/diktat

A generic type parameter in Kdoc should not be reported

Open

#1929 aperta il 8 apr 2024

Vedi su GitHub
 (4 commenti) (2 reazioni) (0 assegnatari)Kotlin (40 fork)github user discovery
buggood first issue

Metriche repository

Star
 (571 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Describe the bug

When documenting a type parameter in Kdoc, the only correct way to do it is using the @param tag, for example:

/**
 * @param T the target type to return
 */
fun <T> genericFunc(): T

Unfortunately Diktat reports:

[KDOC_WITHOUT_PARAM_TAG] all methods which take arguments should have @param tags in KDoc: T param isn't present in argument list

Which I believe is a wrong behavior, given that it's taking into consideration the formal parameters only.

Expected behavior

Diktat should not report a violation for the above example.

Observed behavior

Diktat reports a KDOC_WITHOUT_PARAM_TAG

Environment information

  • diktat version: 2.0.0
  • build tool (maven/gradle): gradle
  • how is diktat run (CLI, plugin, etc.): plugin
  • kotlin version: 1.9.23
  • operating system: MacOS 14.3.1

Guida contributor

Direzione di ricerca
Indaga la regola KDOC WITHOUT PARAM TAG per capire come conta i parametri. Il problema è che include erroneamente i parametri di tipo generico (es. <T>) come parametri del metodo. La correzione dovrebbe escludere i parametri di tipo dal controllo.
Tech stack
kotlin
Dominio
devtools
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Kotlin
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70