update javadoc

Lucas3oo · Aug 16, 2024 · 8874b12 · 8874b12
1 parent 55b77ea
commit 8874b12
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -241,6 +241,8 @@ and `org.sonarsource.kotlin:sonar-kotlin-plugin:2.20.0.4382` and any additionall
 Typical `gradle.build.kts`:
 
 ```Gradle Kotlin DSL
+import se.solrike.sonarlint.*
+
 plugins {
   // Apply the org.jetbrains.kotlin.jvm Plugin to add support for Kotlin.
   id("org.jetbrains.kotlin.jvm") version "1.7.21"

diff --git a/src/main/java/se/solrike/sonarlint/Sonarlint.java b/src/main/java/se/solrike/sonarlint/Sonarlint.java
@@ -171,6 +171,9 @@ public Sonarlint() {
         .set(artifactProvider.map(p -> p.stream().map(ResolvedArtifactResult::getFile).collect(Collectors.toSet())));
   }
 
+  /**
+   * Execute the Sonarlint analysis on the source code.
+   */
   @TaskAction
   public void run() {
     Logger logger = getLogger();