Skip to content

Commit 3929a2d

Browse files
committed
Claude fix all docstring problems & add check to CI
1 parent 5d969b8 commit 3929a2d

25 files changed

Lines changed: 80 additions & 71 deletions

File tree

.github/workflows/ci.yml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ jobs:
191191
- name: Set up Java
192192
uses: actions/setup-java@v5
193193
with:
194-
java-version: "11"
194+
java-version: "23"
195195
distribution: "temurin"
196196

197197
- name: Set up Gradle
@@ -200,6 +200,30 @@ jobs:
200200
- name: Run copyright and code format checks
201201
run: ./gradlew --no-daemon spotlessCheck
202202

203+
javadoc:
204+
name: Javadoc
205+
runs-on: ubuntu-latest
206+
timeout-minutes: 20
207+
steps:
208+
- name: Checkout repo
209+
uses: actions/checkout@v5
210+
with:
211+
fetch-depth: 0
212+
submodules: recursive
213+
ref: ${{ github.event.pull_request.head.sha }}
214+
215+
- name: Set up Java
216+
uses: actions/setup-java@v5
217+
with:
218+
java-version: "23"
219+
distribution: "temurin"
220+
221+
- name: Set up Gradle
222+
uses: gradle/actions/setup-gradle@v5
223+
224+
- name: Run javadoc
225+
run: ./gradlew --no-daemon javadoc
226+
203227
build_native_images:
204228
name: Build native test server
205229
uses: ./.github/workflows/build-native-image.yml

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ src/main/idls/*
1818
.settings
1919
.vscode/
2020
*/bin
21-
/.claude
21+
/.claude
22+
mise.local.toml
23+
**/.factorypath

gradle/java.gradle

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ subprojects {
3232

3333
javadoc {
3434
options.encoding = 'UTF-8'
35-
if (JavaVersion.current().isJava8Compatible()) {
36-
options.addStringOption('Xdoclint:none', '-quiet')
37-
}
35+
options.addStringOption('Xdoclint:reference', '-quiet')
36+
options.addBooleanOption('Werror', true)
3837
if (JavaVersion.current().isJava9Compatible()) {
3938
options.addBooleanOption('html5', true)
4039
}

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public static ClientConfig fromToml(byte[] tomlData, ClientConfigFromTomlOptions
172172
*
173173
* @param config the client config to convert
174174
* @return the TOML data as bytes
175-
* @apiNote The output will not be identical to the input if the config was loaded from a file
175+
* <p>Note: The output will not be identical to the input if the config was loaded from a file
176176
* because comments and formatting are not preserved.
177177
*/
178178
public static byte[] toTomlAsBytes(ClientConfig config) throws IOException {

temporal-remote-data-encoder/src/main/java/io/temporal/payload/codec/AbstractRemoteDataEncoderCodec.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111
/**
1212
* Performs encoding/decoding of the payloads via the Remote Data Encoder (RDE) available over http.
1313
*
14-
* <p>
15-
*
1614
* <h2>Remote Data Encoder Http Server specification</h2>
1715
*
1816
* <p>RDE Server must:

temporal-sdk/src/main/java/io/temporal/activity/ActivityInterface.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@
4242
* When <code>CImpl</code> instance is registered with the {@link io.temporal.worker.Worker} the
4343
* following activities are registered:
4444
*
45-
* <p>
46-
*
4745
* <ul>
4846
* <li>B_a
4947
* <li>B_b

temporal-sdk/src/main/java/io/temporal/client/WorkflowClientPlugin.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
/**
2828
* Plugin interface for customizing Temporal workflow client configuration.
2929
*
30-
* <p>This interface is separate from {@link
31-
* io.temporal.serviceclient.WorkflowServiceStubs.ServiceStubsPlugin} to allow plugins that only
32-
* need to configure the workflow client without affecting the underlying gRPC connection.
30+
* <p>This interface is separate from {@link io.temporal.serviceclient.WorkflowServiceStubsPlugin}
31+
* to allow plugins that only need to configure the workflow client without affecting the underlying
32+
* gRPC connection.
3333
*
3434
* <p>Plugins that implement both {@code ServiceStubsPlugin} and {@code WorkflowClientPlugin} will
3535
* have their service stubs configuration applied when creating the service stubs, and their client
@@ -54,7 +54,7 @@
5454
* }
5555
* }</pre>
5656
*
57-
* @see io.temporal.serviceclient.WorkflowServiceStubs.ServiceStubsPlugin
57+
* @see io.temporal.serviceclient.WorkflowServiceStubsPlugin
5858
* @see io.temporal.worker.WorkerPlugin
5959
* @see SimplePlugin
6060
*/

temporal-sdk/src/main/java/io/temporal/client/WorkflowStub.java

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
import java.lang.reflect.Type;
1111
import java.util.Optional;
1212
import java.util.concurrent.CompletableFuture;
13-
import java.util.concurrent.ExecutionException;
1413
import java.util.concurrent.TimeUnit;
1514
import java.util.concurrent.TimeoutException;
1615
import javax.annotation.Nullable;
@@ -273,8 +272,7 @@ <R> R getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultTy
273272
* @param <R> type of the workflow return value
274273
* @return future completed with workflow return value or an exception
275274
* @see #getResult(Class) as a sync version of this method for detailed information about
276-
* exceptions that may be thrown from {@link CompletableFuture#get()} wrapped by {@link
277-
* ExecutionException}
275+
* exceptions that may be thrown from CompletableFuture.get() wrapped by ExecutionException
278276
*/
279277
<R> CompletableFuture<R> getResultAsync(Class<R> resultClass);
280278

@@ -289,8 +287,7 @@ <R> R getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultTy
289287
* @param <R> type of the workflow return value
290288
* @return future completed with workflow return value or an exception
291289
* @see #getResult(Class, Type) as a sync version of this method for detailed information about
292-
* exceptions that may be thrown from {@link CompletableFuture#get()} wrapped by {@link
293-
* ExecutionException}
290+
* exceptions that may be thrown from CompletableFuture.get() wrapped by ExecutionException
294291
*/
295292
<R> CompletableFuture<R> getResultAsync(Class<R> resultClass, Type resultType);
296293

@@ -305,8 +302,8 @@ <R> R getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultTy
305302
* @param <R> type of the workflow return value
306303
* @return future completed with workflow return value or an exception
307304
* @see #getResult(long, TimeUnit, Class) as a sync version of this method for detailed
308-
* information about exceptions that may be thrown from {@link CompletableFuture#get()}
309-
* wrapped by {@link ExecutionException}
305+
* information about exceptions that may be thrown from CompletableFuture.get() wrapped by
306+
* ExecutionException
310307
*/
311308
<R> CompletableFuture<R> getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass);
312309

@@ -323,8 +320,8 @@ <R> R getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultTy
323320
* @param <R> type of the workflow return value
324321
* @return future completed with workflow return value or an exception
325322
* @see #getResult(long, TimeUnit, Class, Type) as a sync version of this method for detailed
326-
* information about exceptions that may be thrown from {@link CompletableFuture#get()}
327-
* wrapped by {@link ExecutionException}
323+
* information about exceptions that may be thrown from CompletableFuture.get() wrapped by
324+
* ExecutionException
328325
*/
329326
<R> CompletableFuture<R> getResultAsync(
330327
long timeout, TimeUnit unit, Class<R> resultClass, Type resultType);

temporal-sdk/src/main/java/io/temporal/common/interceptors/WorkflowInboundCallsInterceptor.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* parameters.
2323
*
2424
* @see WorkerInterceptor#interceptWorkflow(WorkflowInboundCallsInterceptor) for a definition of
25-
* "next" {@link WorkflowInboundCallsInterceptor}
25+
* "next" WorkflowInboundCallsInterceptor
2626
*/
2727
@Experimental
2828
public interface WorkflowInboundCallsInterceptor {
@@ -168,8 +168,8 @@ public Object getResult() {
168168
*
169169
* @param outboundCalls an existing interceptor instance to be proxied by the interceptor created
170170
* inside this method
171-
* @see WorkerInterceptor#interceptWorkflow for the definition of "next" {@link
172-
* WorkflowInboundCallsInterceptor}
171+
* @see WorkerInterceptor#interceptWorkflow for the definition of "next"
172+
* WorkflowInboundCallsInterceptor
173173
*/
174174
void init(WorkflowOutboundCallsInterceptor outboundCalls);
175175

temporal-sdk/src/main/java/io/temporal/common/interceptors/WorkflowOutboundCallsInterceptor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
* implementation must forward all the calls to the outbound interceptor passed as a {@code
3434
* outboundCalls} parameter to the {@code init} call.
3535
*
36-
* @see WorkerInterceptor#interceptWorkflow for the definition of "next" {@link
37-
* WorkflowInboundCallsInterceptor}.
36+
* @see WorkerInterceptor#interceptWorkflow for the definition of "next"
37+
* WorkflowInboundCallsInterceptor.
3838
*/
3939
@Experimental
4040
public interface WorkflowOutboundCallsInterceptor {

0 commit comments

Comments
 (0)