Close #26

mathieucarbou · Sep 19, 2021 · 9daca30 · 9daca30
1 parent 9d4bdfb
commit 9daca30
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/HeaderSection.java b/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/HeaderSection.java
@@ -19,12 +19,27 @@
 
 public class HeaderSection {
 
+  /**
+   * The name of this section to match. Example:
+   * <p>
+   * {@code COPYRIGHT_SECTION}
+   */
   @Parameter
   String key;
 
+  /**
+   * The default value that will be used. Example:
+   * <p>
+   * {@code Copyright (C) 2011 http://code.google.com/p/maven-license-plugin/}
+   */
   @Parameter
   String defaultValue;
 
+  /**
+   * The pattern to use to match this section in the header. Example:
+   * <p>
+   * {@code Copyright \(C\) \d{4} .*}
+   */
   @Parameter
   String ensureMatch;