Enhance examples/maven/pom.xml with a doc comment

### What's done: * An inline doc comment was added to `examples/maven/pom.xml`.
saveourtool · May 25, 2022 · 39339ee · 39339ee
1 parent 4656b80
commit 39339ee
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml
@@ -11,6 +11,12 @@
         <diktat.version>1.1.0</diktat.version>
     </properties>
 
+    <!-- This is an example of how DiKTat performs static code analysis.
+
+         If you also wish to compile your code, typically via "mvn compile"
+         be sure to follow the instructions at https://kotlinlang.org/docs/maven.html
+         and include the kotlin-maven-plugin. -->
+
     <build>
         <plugins>
             <plugin>