Skip to content

Commit

Permalink
[ci-commit] [documentation] updated documentation for 1.1.0-SNAPSHOT
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Jul 14, 2023
1 parent b72687f commit 51b9561
Show file tree
Hide file tree
Showing 16 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions ...ion/1.1.0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-reader/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-list.html">E</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><a href="../next-list.html"><span class="token function">nextList</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">readerFn<span class="token operator">: </span><span class="token keyword"></span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../next-list.html">E</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-list.html">E</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Reads a list of <a href="../next-list.html">E</a> from this <a href="index.html">JsonReader</a>. This function assumes it is called at the start of a JSON-array and reads each element using the supplied <a href="../next-list.html">readerFn</a>.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-list.html">E</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><a href="../next-list.html"><span class="token function">nextList</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">readerFn<span class="token operator">: </span><span class="token keyword"></span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../next-list.html">E</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-list.html">E</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Reads a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a> of <a href="../next-list.html">E</a> from this <a href="index.html">JsonReader</a>. This function assumes it is called at the start of a JSON-array and reads each element using the supplied <a href="../next-list.html">readerFn</a>.</p></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -309,7 +309,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-set.html">E</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><a href="../next-set.html"><span class="token function">nextSet</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">readerFn<span class="token operator">: </span><span class="token keyword"></span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../next-set.html">E</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-set.html">E</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Reads a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/index.html">set</a> of <a href="../next-set.html">E</a> from this <a href="index.html">JsonReader</a>. This function assumes it is called at the start of a JSON-array and reads each element using the supplied <a href="../next-set.html">readerFn</a>.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-set.html">E</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><a href="../next-set.html"><span class="token function">nextSet</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">readerFn<span class="token operator">: </span><span class="token keyword"></span><a href="index.html">JsonReader</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../next-set.html">E</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../next-set.html">E</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Reads a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a> of <a href="../next-set.html">E</a> from this <a href="index.html">JsonReader</a>. This function assumes it is called at the start of a JSON-array and reads each element using the supplied <a href="../next-set.html">readerFn</a>.</p></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion ....0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/-json-writer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span>Json</span><wbr></wbr><span><span>Writer</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="https://square.github.io/okio/3.x/okio/okio/okio/-buffered-sink/index.html">BufferedSink</a><span class="token punctuation">, </span></span><span class="parameter ">prettyPrint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="https://square.github.io/okio/3.x/okio/okio/okio/-buffered-sink/index.html">BufferedSink</a><span class="token punctuation">, </span></span><span class="parameter ">prettyPrint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Creates a new instance that reads a JSON-encoded stream to <span data-unresolved-link="com.fab1an.kotlinjsonstream/JsonWriter/&amp;lt;init&amp;gt;/#okio.BufferedSink#kotlin.Boolean/PointingToCallableParameters(0)/">sink</span>. If <span data-unresolved-link="com.fab1an.kotlinjsonstream/JsonWriter/&amp;lt;init&amp;gt;/#okio.BufferedSink#kotlin.Boolean/PointingToCallableParameters(1)/">prettyPrint</span> is enabled the output is formatted with indents, spaces and newlines.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ...1.0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/begin-array.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span>begin</span><wbr></wbr><span><span>Array</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="begin-array.html"><span class="token function">beginArray</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="begin-array.html"><span class="token function">beginArray</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div><p class="paragraph">Begins a new array.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ....0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/begin-object.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span>begin</span><wbr></wbr><span><span>Object</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="begin-object.html"><span class="token function">beginObject</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="begin-object.html"><span class="token function">beginObject</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div><p class="paragraph">Begins a new object.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ...ion/1.1.0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/close.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span><span>close</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="close.html"><span class="token function">close</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="close.html"><span class="token function">close</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><p class="paragraph">Closes the underlying <span data-unresolved-link="com.fab1an.kotlinjsonstream/JsonWriter/sink/#/PointingToDeclaration/">sink</span>.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ...1.1.0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/end-array.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span>end</span><wbr></wbr><span><span>Array</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="end-array.html"><span class="token function">endArray</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="end-array.html"><span class="token function">endArray</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div><p class="paragraph">Ends the current array.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ....1.0-SNAPSHOT/kotlin-json-stream/com.fab1an.kotlinjsonstream/-json-writer/end-object.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<div class="cover ">
<h1 class="cover"><span>end</span><wbr></wbr><span><span>Object</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="end-object.html"><span class="token function">endObject</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="end-object.html"><span class="token function">endObject</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">JsonWriter</a></div><p class="paragraph">Ends the current object.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
Expand Down
Loading

0 comments on commit 51b9561

Please sign in to comment.