feat: add Javadoc verification step in build workflow and update example usage formatting

brunoborges · brunoborges · commit 6dd9f2457a34 · 2026-01-29T14:53:52.000-05:00
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -47,6 +47,9 @@ jobs:
       - name: Build SDK and clone test harness
         run: mvn test-compile
 
+      - name: Verify Javadoc generation
+        run: mvn javadoc:javadoc -q
+
       - name: Install Copilot CLI from cloned SDK
         id: setup-copilot
         run: |
diff --git a/pom.xml b/pom.xml
@@ -72,6 +72,20 @@
     </dependencies>
 
     <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>3.12.0</version>
+                    <configuration>
+                        <show>public</show>
+                        <nohelp>true</nohelp>
+                        <doclint>none</doclint>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -292,12 +306,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.12.0</version>
-                <configuration>
-                    <show>public</show>
-                    <nohelp>true</nohelp>
-                    <doclint>none</doclint>
-                </configuration>
                 <reportSets>
                     <reportSet>
                         <reports>
@@ -330,7 +338,6 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>3.12.0</version>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
diff --git a/src/main/java/com/github/copilot/sdk/CopilotSession.java b/src/main/java/com/github/copilot/sdk/CopilotSession.java
@@ -312,7 +312,9 @@ public Closeable on(Consumer<AbstractSessionEvent> handler) {
      * {@code instanceof} checks. The handler will only be called for events
      * matching the specified type.
      *
-     * <h2>Example Usage</h2>
+     * <p>
+     * <b>Example Usage</b>
+     * </p>
      *
      * <pre>{@code
      * // Handle assistant messages

Original file line number	Diff line number	Diff line change
`@@ -312,7 +312,9 @@ public Closeable on(Consumer<AbstractSessionEvent> handler) {`
`312`	`312`	`* {@code instanceof} checks. The handler will only be called for events`
`313`	`313`	`* matching the specified type.`
`314`	`314`	`*`
`315`		`- * <h2>Example Usage</h2>`
	`315`	`+ * <p>`
	`316`	`+ * <b>Example Usage</b>`
	`317`	`+ * </p>`
`316`	`318`	`*`
`317`	`319`	`* <pre>{@code`
`318`	`320`	`* // Handle assistant messages`