Add javadocs test (#352)

.github/workflows/ci.yml

@@ -40,6 +40,26 @@ jobs:
           name: Test results (Java ${{ matrix.java }})
           path: "**/test-results/test/*.xml"
 
+  test-javadocs:
+    name: Test Javadocs
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          # We test with same Java version and distribution used by the Docs script
+          # https://github.com/restatedev/documentation/blob/main/.github/workflows/pre-release.yml
+          distribution: 'temurin'
+          java-version: '21'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Build Javadocs
+        run: gradle :sdk-aggregated-javadocs:javadoc
+      - name: Build Kotlin docs
+        run: gradle :dokkaHtmlMultiModule
+
   event_file:
     name: "Event File"
     runs-on: ubuntu-latest

sdk-api/src/main/java/dev/restate/sdk/Context.java

@@ -106,10 +106,8 @@ default void sleep(Duration duration) {
    * <p>The closure should tolerate retries, that is Restate might re-execute the closure multiple
    * times until it records a result.
    *
-   * <h2>Error handling</h2>
-   *
-   * Errors occurring within this closure won't be propagated to the caller, unless they are {@link
-   * TerminalException}. Consider the following code:
+   * <p><b>Error handling</b>: Errors occurring within this closure won't be propagated to the
+   * caller, unless they are {@link TerminalException}. Consider the following code:
    *
    * <pre>{@code
    * // Bad usage of try-catch outside the run