Added comment to the unary-op-spacing rule

saveourtool · May 17, 2019 · 12a6864 · 12a6864
1 parent 342f0bb
commit 12a6864
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/.../src/main/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundUnaryOperatorsRule.kt b/.../src/main/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundUnaryOperatorsRule.kt
@@ -17,6 +17,11 @@ import org.jetbrains.kotlin.com.intellij.psi.PsiWhiteSpace
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafElement
 import org.jetbrains.kotlin.com.intellij.psi.tree.TokenSet
 
+/**
+ * Ensures there are no spaces around unary operators
+ *
+ * @see [Kotlin Style Guide](https://kotlinlang.org/docs/reference/coding-conventions.html#horizontal-whitespace)
+ */
 class SpacingAroundUnaryOperatorsRule : Rule("unary-op-spacing") {
 
     private val tokenSet = TokenSet.create(PLUS, PLUSPLUS, MINUS, MINUSMINUS, EXCL, EXCLEXCL)