Fix aggregate javadoc

jstachio · Jan 5, 2024 · cd16704 · cd16704
1 parent c75ea6e
commit cd16704
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/bin/doc.sh b/bin/doc.sh
@@ -0,0 +1 @@
+mvn --batch-mode --no-transfer-progress -Pdoc clean install -DskipTests=true
diff --git a/rainbowgum-config-apt/pom.xml b/rainbowgum-config-apt/pom.xml
@@ -90,5 +90,11 @@
         </plugins>
       </build>
     </profile>
+    <profile>
+      <id>doc</id>
+      <properties>
+        <maven.javadoc.skip>true</maven.javadoc.skip>
+      </properties>
+    </profile>
   </profiles>
 </project>
diff --git a/rainbowgum-config-apt/src/main/resources/io/jstach/rainbowgum/apt/ConfigBuilder.java b/rainbowgum-config-apt/src/main/resources/io/jstach/rainbowgum/apt/ConfigBuilder.java
@@ -12,13 +12,17 @@
  * <tr>
  * <th>Property Pattern</th>
  * <th>Type</th>
+ * <th>Required</th>
+ * <th>Default</th>
  * <th>Description</th>
  * </tr>
  $$#properties$$
  $$#normal$$
  * <tr>
- * <td>{@value $$propertyLiteral$$ }</td>
+ * <td><code>{@value $$propertyLiteral$$ }</code></td>
  * <td><code>$$type$$</code></td>
+ * <td><code>$$required$$</code></td>
+ * <td><code>$$defaultValue$$</code></td>
  * <td>$$javadoc$$</td>
  * </tr>
  $$/normal$$ 
@@ -88,7 +92,7 @@ public final class $$builderName$$ {
 	$$#normal$$
 
 	/**
-	 * Sets $$#required$$<strong>required</strong>$$/required$$$$name$$.
+	 * Sets $$#required$$<strong>required</strong> $$/required$$$$name$$.
 	 * @param $$name$$ <code>{@value #$$propertyLiteral$$ } = $$type$$</code> $$javadoc$$
 	 * @return this builder.
 	 */
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		mvn --batch-mode --no-transfer-progress -Pdoc clean install -DskipTests=true