Fix small javadoc warnings (to get back to 0 warnings)

FasterXML · Sep 28, 2021 · ec22344 · ec22344
1 parent 542654c
commit ec22344
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/main/java/com/fasterxml/jackson/core/JsonStreamContext.java b/src/main/java/com/fasterxml/jackson/core/JsonStreamContext.java
@@ -284,7 +284,7 @@ public JsonPointer pathAsPointer(boolean includeRoot) {
      * @param srcRef Source reference needed to construct location instance
      *
      * @return Location pointing to the point where the context
-     *   start marker was found (or written); never `null`.
+     *   start marker was found (or written); never {@code null}.
      *
      * @since 2.13
      */
@@ -293,6 +293,9 @@ public JsonLocation startLocation(ContentReference srcRef) {
     }
 
     /**
+     * @param srcRef Source reference needed to construct location instance
+     * @return Location pointing to the point where the context
+     *   start marker was found (or written); never {@code null}.
      * @since 2.9
      * @deprecated Since 2.13 use {@link #startLocation} instead
      */

diff --git a/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java b/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java
@@ -109,6 +109,8 @@ public static int releaseBuffers() {
     /**
      * Not to be used any more: call {@link JsonStringEncoder#getInstance()} instead.
      *
+     * @return {@code JsonStringEncoder} instance to use.
+     *
      * @deprecated Since 2.10 (note: was accidentally removed but reintroduced as deprecated
      *    in 2.12.5, to be removed from 3.0)
      */
@@ -121,6 +123,9 @@ public static JsonStringEncoder getJsonStringEncoder() {
      * Not to be used any more: call {@link JsonStringEncoder#getInstance()} (and then
      * {@code encodeAsUTF8()}) instead.
      *
+     * @param text String to encode
+     * @return String encoded as UTF-8 bytes.
+     *
      * @deprecated Since 2.10 (note: was accidentally removed but reintroduced as deprecated
      *    in 2.12.5, to be removed from 3.0)
      */