Package org.cqfn.diktat.ruleset.rules.chapter2.kdoc
See: Description
-
Class Summary Class Description CommentsFormattingConfiguration RuleConfiguration for CommentsFormatting rule CommentsFormatting This class handles rule 2. KdocComments This rule checks the following features in KDocs: All top-level (file level) functions and classes with public or internal access should have KDoc
All internal elements in class like class, property or function should be documented with KDoc
All properties declared in the primary constructor are documented using
@property
tag in class KDoc
KdocFormatConfiguration A RuleConfiguration for KDoc formatting KdocFormatting Formatting visitor for Kdoc: removing all blank lines between Kdoc and the code it's declaring
ensuring there are no tags with empty content
ensuring there is only one white space between tag and it's body
ensuring tags @apiNote, @implSpec, @implNote have one empty line after their body
ensuring tags @param, @return, @throws are arranged in this order
ensuring @author tag is not used
ensuring @since tag contains only versions and not dates
KdocMethods This rule checks that whenever the method has arguments, return value, can throw exceptions, KDoc block should contain @param
,@return
,@throws
.