Merge pull request #137 from ascopes/task/improve-defaults

Improve optional param documentation
ascopes · Mar 22, 2024 · c7ffba8 · c7ffba8
2 parents 24523f5 + 84b0a8a
commit c7ffba8
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java b/src/main/java/io/github/ascopes/protobufmavenplugin/AbstractGenerateMojo.java
@@ -94,7 +94,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    *
    * <p>Leave unspecified or explicitly null/empty to use the defaults.
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.0.1
    */
@@ -109,7 +109,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    * <p>If you wish to depend on a JAR containing protobuf sources, add it as a dependency
    * with the {@code provided} or {@code test} scope instead.
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.1.0
    */
@@ -139,7 +139,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    * executable, or are using a more obscure system architecture, then using a
    * {@code jvmMavenPlugin} may be more preferrable.
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.3.0
    */
@@ -157,7 +157,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    * </binaryPathPlugins>
    * }</pre>
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.3.0
    */
@@ -184,7 +184,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    *   </binaryUrlPlugins>
    * }</pre>
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.4.0
    */
@@ -212,7 +212,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    * <p>This mechanism allows plugin vendors to implement their plugins in
    * Java and just distribute platform-independent JAR instead.
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.3.0
    */
@@ -225,7 +225,7 @@ public abstract class AbstractGenerateMojo extends AbstractMojo {
    * <p>Leave unspecified or explicitly null to use the default for the
    * goal. This defaults to the Maven generated sources directory within {@code target/}.
    *
-   * <p><strong>Default:</strong> {@code null}.
+   * <p>This parameter is optional.
    *
    * @since 0.1.0
    */