From 4a945be0babbd89e3e9ed1ede31ad2559775b52c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Istv=C3=A1n=20R=C3=A1tkai?= <istvan@berrycloud.co.uk>
Date: Tue, 18 Apr 2023 12:36:21 +0100
Subject: [PATCH 1/2] add missing javadoc comments

---
 .../xapi/client/AttachmentHttpMessageWriter.java  |  9 +++++++++
 .../xapi/client/StatementHttpMessageReader.java   | 15 ++++++++++++---
 .../xapi/client/StatementHttpMessageWriter.java   |  7 ++++++-
 3 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/xapi-client/src/main/java/dev/learning/xapi/client/AttachmentHttpMessageWriter.java b/xapi-client/src/main/java/dev/learning/xapi/client/AttachmentHttpMessageWriter.java
index 376b30f4..54ae1552 100644
--- a/xapi-client/src/main/java/dev/learning/xapi/client/AttachmentHttpMessageWriter.java
+++ b/xapi-client/src/main/java/dev/learning/xapi/client/AttachmentHttpMessageWriter.java
@@ -27,15 +27,24 @@
 public class AttachmentHttpMessageWriter extends MultipartWriterSupport
     implements HttpMessageWriter<Attachment> {
 
+  /**
+   * Default constructor.
+   */
   public AttachmentHttpMessageWriter() {
     super(List.of(MediaType.MULTIPART_MIXED));
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType) {
     return Attachment.class.isAssignableFrom(elementType.toClass());
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public Mono<Void> write(Publisher<? extends Attachment> parts, ResolvableType elementType,
       @Nullable MediaType mediaType, ReactiveHttpOutputMessage outputMessage,
diff --git a/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageReader.java b/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageReader.java
index 3700b51d..ddab596a 100644
--- a/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageReader.java
+++ b/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageReader.java
@@ -38,12 +38,17 @@ public class StatementHttpMessageReader extends LoggingCodecSupport
 
   private final HttpMessageReader<Part> partReader = new DefaultPartHttpMessageReader();
 
-
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public List<MediaType> getReadableMediaTypes() {
     return MIME_TYPES;
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public boolean canRead(ResolvableType elementType, @Nullable MediaType mediaType) {
     if (Statement.class.equals(elementType.toClass())
@@ -60,7 +65,9 @@ public boolean canRead(ResolvableType elementType, @Nullable MediaType mediaType
     return false;
   }
 
-
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public Flux<Object> read(ResolvableType elementType, ReactiveHttpInputMessage message,
       Map<String, Object> hints) {
@@ -68,7 +75,9 @@ public Flux<Object> read(ResolvableType elementType, ReactiveHttpInputMessage me
     return Flux.from(readMono(elementType, message, hints));
   }
 
-
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public Mono<Object> readMono(ResolvableType elementType, ReactiveHttpInputMessage inputMessage,
       Map<String, Object> hints) {
diff --git a/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageWriter.java b/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageWriter.java
index be3984c6..5cb1232c 100644
--- a/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageWriter.java
+++ b/xapi-client/src/main/java/dev/learning/xapi/client/StatementHttpMessageWriter.java
@@ -69,11 +69,17 @@ public StatementHttpMessageWriter(List<HttpMessageWriter<?>> list) {
 
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType) {
     return true;
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   @SuppressWarnings("unchecked")
   public Mono<Void> write(Publisher<? extends Object> inputStream, ResolvableType elementType,
@@ -150,7 +156,6 @@ private <T> Flux<DataBuffer> encodePart(byte[] boundary, Object body, DataBuffer
         generateNewLine(factory));
   }
 
-
   @SuppressWarnings("unchecked")
   private List<Object> getParts(Object object) {
 

From 43b90c9bdccf2ab3b62b1a74a9f66ffc00310c73 Mon Sep 17 00:00:00 2001
From: Thomas Turrell-Croft <tom@berrycloud.co.uk>
Date: Tue, 18 Apr 2023 18:21:34 +0100
Subject: [PATCH 2/2] Correct typo in javadoc

---
 .../java/dev/learning/xapi/client/PostStatementRequest.java    | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/xapi-client/src/main/java/dev/learning/xapi/client/PostStatementRequest.java b/xapi-client/src/main/java/dev/learning/xapi/client/PostStatementRequest.java
index 17a7b6fe..2fa65029 100644
--- a/xapi-client/src/main/java/dev/learning/xapi/client/PostStatementRequest.java
+++ b/xapi-client/src/main/java/dev/learning/xapi/client/PostStatementRequest.java
@@ -85,8 +85,7 @@ public Builder statement(Statement statement) {
      * Consumer Builder for signed statement.
      *
      * @param statement The Consumer Builder for signed-statement
-     *
-     * @paraam privateKey a PrivateKey for signing the Statement
+     * @param privateKey a PrivateKey for signing the Statement
      *
      * @return This builder
      *