Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JsonWriter documentation regarding top-level value #1766

Merged
merged 3 commits into from
Aug 7, 2022
Merged

Fix JsonWriter documentation regarding top-level value #1766

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0956ae7
Fix JsonReader / JsonWriter documentation regarding top-level value
Marcono1234 Aug 25, 2020
2ba3d90
Merge branch 'master' into marcono1234/fix-javadoc-any-top-level-valu…
Marcono1234 Aug 7, 2022
c0068f9
Fix missing space
Marcono1234 Aug 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions gson/src/main/java/com/google/gson/stream/JsonWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,9 @@
* and end delimiters of objects and arrays.
*
* <h3>Encoding JSON</h3>
* To encode your data as JSON, create a new {@code JsonWriter}. Each JSON
* document must contain one top-level array or object. Call methods on the
* writer as you walk the structure's contents, nesting arrays and objects as
* necessary:
* To encode your data as JSON, create a new {@code JsonWriter}. Call methods
* on the writer as you walk the structure's contents, nesting arrays and objects
* as necessary:
* <ul>
* <li>To write <strong>arrays</strong>, first call {@link #beginArray()}.
* Write each of the array's elements with the appropriate {@link #value}
Expand Down Expand Up @@ -170,7 +169,7 @@ public class JsonWriter implements Closeable, Flushable {
HTML_SAFE_REPLACEMENT_CHARS['\''] = "\\u0027";
}

/** The output data, containing at most one top-level array or object. */
/** The JSON output destination */
private final Writer out;

private int[] stack = new int[32];
Expand Down Expand Up @@ -234,8 +233,6 @@ public final void setIndent(String indent) {
* href="http://www.ietf.org/rfc/rfc7159.txt">RFC 7159</a>. Setting the writer
* to lenient permits the following:
* <ul>
* <li>Top-level values of any type. With strict writing, the top-level
* value must be an object or an array.
* <li>Numbers may be {@link Double#isNaN() NaNs} or {@link
* Double#isInfinite() infinities}.
* </ul>
Expand Down