From 23d906d385c1046060bfbd0139b954f916c806d0 Mon Sep 17 00:00:00 2001 From: Moataz Abdelnasser Date: Mon, 9 May 2022 04:33:17 +0200 Subject: [PATCH] Javadoc edits --- .../adapter/jackson/JacksonAdapterFactory.java | 9 ++++----- methanol-jackson/src/main/java/module-info.java | 12 ++++++------ 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/methanol-jackson/src/main/java/com/github/mizosoft/methanol/adapter/jackson/JacksonAdapterFactory.java b/methanol-jackson/src/main/java/com/github/mizosoft/methanol/adapter/jackson/JacksonAdapterFactory.java index 38e4719d5..66c7cf948 100644 --- a/methanol-jackson/src/main/java/com/github/mizosoft/methanol/adapter/jackson/JacksonAdapterFactory.java +++ b/methanol-jackson/src/main/java/com/github/mizosoft/methanol/adapter/jackson/JacksonAdapterFactory.java @@ -105,7 +105,7 @@ mapper, writerFactory, toMediaTypeArray(firstMediaType, otherMediaTypes)) } /** - * Returns an {@code Decoder} that uses a default {@code ObjectMapper} for JSON and is only + * Returns a {@code Decoder} that uses a default {@code ObjectMapper} for JSON and is only * compatible with {@code application/json}. * * @deprecated Use {@link #createJsonDecoder()}. @@ -116,7 +116,7 @@ public static Decoder createDecoder() { } /** - * Returns an {@code Decoder} that uses the given {@code ObjectMapper} and is only compatible with + * Returns a {@code Decoder} that uses the given {@code ObjectMapper} and is only compatible with * {@code application/json}. * * @deprecated Use {@link #createJsonDecoder(ObjectMapper)}. @@ -127,7 +127,7 @@ public static Decoder createDecoder(ObjectMapper mapper) { } /** - * Returns an {@code Decoder} that uses a default {@code ObjectMapper} for JSON and is only + * Returns a {@code Decoder} that uses a default {@code ObjectMapper} for JSON and is only * compatible with {@code application/json}. */ public static Decoder createJsonDecoder() { @@ -135,7 +135,7 @@ public static Decoder createJsonDecoder() { } /** - * Returns an {@code Decoder} that uses the given {@code ObjectMapper} and is only compatible with + * Returns a {@code Decoder} that uses the given {@code ObjectMapper} and is only compatible with * {@code application/json}. */ public static Decoder createJsonDecoder(ObjectMapper mapper) { @@ -180,7 +180,6 @@ private static MediaType[] toMediaTypeArray( private static boolean isBinaryFormat(ObjectMapper mapper) { var factory = mapper.getFactory(); try { - // Attempt to create a generator from a Writer factory.createGenerator(Writer.nullWriter()); } catch (UnsupportedOperationException e) { return true; diff --git a/methanol-jackson/src/main/java/module-info.java b/methanol-jackson/src/main/java/module-info.java index ec9438f74..3b8818b20 100644 --- a/methanol-jackson/src/main/java/module-info.java +++ b/methanol-jackson/src/main/java/module-info.java @@ -24,10 +24,10 @@ /** * Provides {@link com.github.mizosoft.methanol.BodyAdapter.Encoder} and {@link - * com.github.mizosoft.methanol.BodyAdapter.Decoder} implementations for JSON using the Jackson - * library. Note that, for the sake of configurability, the adapters are not service-provided by - * default. You will need to explicitly declare service-providers that delegate to the instances - * created by {@link JacksonAdapterFactory}. + * com.github.mizosoft.methanol.BodyAdapter.Decoder} implementations for the Jackson library. Note + * that, for the sake of configurability, the adapters are not service-provided by default. You will + * need to explicitly declare service-providers that delegate to the instances created by {@link + * JacksonAdapterFactory}. */ module methanol.adapter.jackson { requires transitive methanol; @@ -35,6 +35,6 @@ requires static org.checkerframework.checker.qual; exports com.github.mizosoft.methanol.adapter.jackson; - exports com.github.mizosoft.methanol.adapter.jackson.internal - to methanol.adapter.jackson.flux; + exports com.github.mizosoft.methanol.adapter.jackson.internal to + methanol.adapter.jackson.flux; }