Skip to content

Commit 00a8c72

Browse files
committed
more javadoc stuff
1 parent a40a7f7 commit 00a8c72

File tree

6 files changed

+17
-7
lines changed

6 files changed

+17
-7
lines changed

Diff for: src/main/java/com/fasterxml/jackson/core/async/NonBlockingInputFeeder.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@ public interface NonBlockingInputFeeder
1818
* Method called to check whether it is ok to feed more data: parser returns true
1919
* if it has no more content to parse (and it is ok to feed more); otherwise false
2020
* (and no data should yet be fed).
21+
*
22+
* @return {@code True} if more input is needed (and can be fed); {@code false} if
23+
* there is still some input to decode
2124
*/
2225
public boolean needMoreInput();
2326

2427
/**
2528
* Method that should be called after last chunk of data to parse has been fed
26-
* (with <code>feedInput</code> in sub-class); can be called regardless of what {@link #needMoreInput}
29+
* (with {@code feedInput} in sub-class); can be called regardless of what
30+
* {@link #needMoreInput}
2731
* returns. After calling this method, no more data can be fed; and parser assumes
2832
* no more data will be available.
2933
*/

Diff for: src/main/java/com/fasterxml/jackson/core/io/CharTypes.java

+7
Original file line numberDiff line numberDiff line change
@@ -206,13 +206,20 @@ public final class CharTypes
206206
* Value of 0 means "no escaping"; other positive values that value is character
207207
* to use after backslash; and negative values that generic (backslash - u)
208208
* escaping is to be used.
209+
*
210+
* @return 128-entry {@code int[]} that contains escape definitions
209211
*/
210212
public static int[] get7BitOutputEscapes() { return sOutputEscapes128; }
211213

212214
/**
213215
* Alternative to {@link #get7BitOutputEscapes()} when a non-standard quote character
214216
* is used.
215217
*
218+
* @param quoteChar Character used for quoting textual values and property names;
219+
* usually double-quote but sometimes changed to single-quote (apostrophe)
220+
*
221+
* @return 128-entry {@code int[]} that contains escape definitions
222+
*
216223
* @since 2.10
217224
*/
218225
public static int[] get7BitOutputEscapes(int quoteChar) {

Diff for: src/main/java/com/fasterxml/jackson/core/util/InternCache.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package com.fasterxml.jackson.core.util;
22

3-
import java.util.LinkedHashMap;
43
import java.util.concurrent.ConcurrentHashMap;
54

65
/**
@@ -9,7 +8,7 @@
98
* performance optimization, to avoid calling native intern() method
109
* in cases where same String is being interned multiple times.
1110
*<p>
12-
* Note: that this class extends {@link LinkedHashMap} is an implementation
11+
* Note: that this class extends {@link java.util.LinkedHashMap} is an implementation
1312
* detail -- no code should ever directly call Map methods.
1413
*/
1514
public final class InternCache

Diff for: src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,7 @@ protected JsonParserSequence(JsonParser[] parsers) {
6060
this(false, parsers);
6161
}
6262

63-
/**
64-
* @since 2.8
65-
*/
63+
// @since 2.8
6664
protected JsonParserSequence(boolean checkForExistingToken, JsonParser[] parsers)
6765
{
6866
super(parsers[0]);

Diff for: src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java

+2
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ public void setRootValueSeparator(String sep) {
5454
}
5555

5656
/**
57+
* @param separators Separator definitions
58+
*
5759
* @since 2.9
5860
*/
5961
public MinimalPrettyPrinter setSeparators(Separators separators) {

Diff for: src/main/java/com/fasterxml/jackson/core/util/TextBuffer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import com.fasterxml.jackson.core.io.NumberInput;
88

99
/**
10-
* TextBuffer is a class similar to {@link StringBuffer}, with
10+
* TextBuffer is a class similar to {@link java.lang.StringBuffer}, with
1111
* following differences:
1212
*<ul>
1313
* <li>TextBuffer uses segments character arrays, to avoid having

0 commit comments

Comments
 (0)