Skip to content

Commit 0c8a3d1

Browse files
Configure maven-javadoc-plugin to suppress Lombok-related warnings and fix remaining javadoc issues
Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>
1 parent 8886ad3 commit 0c8a3d1

3 files changed

Lines changed: 18 additions & 1 deletion

File tree

pom.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,11 @@
119119
<plugin>
120120
<groupId>org.apache.maven.plugins</groupId>
121121
<artifactId>maven-javadoc-plugin</artifactId>
122+
<configuration>
123+
<!-- Suppress warnings for Lombok-generated code -->
124+
<doclint>all,-missing</doclint>
125+
<quiet>true</quiet>
126+
</configuration>
122127
<executions>
123128
<execution>
124129
<id>attach-javadocs</id>

xapi-client/src/main/java/dev/learning/xapi/client/XapiClient.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ public Mono<ResponseEntity<UUID>> postStatement(PostStatementRequest request) {
160160
* The returned ResponseEntity contains the response headers and the Statement identifier.
161161
* </p>
162162
*
163+
* @param request the consumer builder for the post statement request
164+
*
163165
* @return the ResponseEntity
164166
*/
165167
public Mono<ResponseEntity<UUID>> postStatement(Consumer<PostStatementRequest.Builder> request) {
@@ -179,6 +181,8 @@ public Mono<ResponseEntity<UUID>> postStatement(Consumer<PostStatementRequest.Bu
179181
* identifiers.
180182
* </p>
181183
*
184+
* @param request the post statements request
185+
*
182186
* @return the ResponseEntity
183187
*/
184188
public Mono<ResponseEntity<List<UUID>>> postStatements(PostStatementsRequest request) {
@@ -206,6 +210,8 @@ public Mono<ResponseEntity<List<UUID>>> postStatements(PostStatementsRequest req
206210
* identifiers.
207211
* </p>
208212
*
213+
* @param request the consumer builder for the post statements request
214+
*
209215
* @return the ResponseEntity
210216
*/
211217
public Mono<ResponseEntity<List<UUID>>> postStatements(
@@ -225,6 +231,8 @@ public Mono<ResponseEntity<List<UUID>>> postStatements(
225231
* The returned ResponseEntity contains the response headers and the voided Statement.
226232
* </p>
227233
*
234+
* @param request the get voided statement request
235+
*
228236
* @return the ResponseEntity
229237
*/
230238
public Mono<ResponseEntity<Statement>> getVoidedStatement(GetVoidedStatementRequest request) {
@@ -249,6 +257,8 @@ public Mono<ResponseEntity<Statement>> getVoidedStatement(GetVoidedStatementRequ
249257
* The returned ResponseEntity contains the response headers and the voided Statement.
250258
* </p>
251259
*
260+
* @param request the consumer builder for the get voided statement request
261+
*
252262
* @return the ResponseEntity
253263
*/
254264
public Mono<ResponseEntity<Statement>> getVoidedStatement(

xapi-model/src/main/java/dev/learning/xapi/jackson/model/strict/XapiTimestamp.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ private XapiTimestamp() {
2323
}
2424

2525
/**
26-
* {@inheritDoc} Converts ISO 8601 string to {@link java.time.Instant}.
26+
* Converts ISO 8601 string to {@link java.time.Instant}.
27+
*
28+
* @param text the ISO 8601 timestamp string
2729
*
2830
* @return {@link java.time.Instant} of text input
2931
*/

0 commit comments

Comments
 (0)