Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/ray/kotlin-v1.12.1-beta07' into …
Browse files Browse the repository at this point in the history
…gh-pages

* origin/ray/kotlin-v1.12.1-beta07:
  Update documentation
  • Loading branch information
rjrjr committed Jan 22, 2024
2 parents a1109b1 + 2855387 commit 94885ae
Show file tree
Hide file tree
Showing 727 changed files with 33,435 additions and 6,717 deletions.
24 changes: 1 addition & 23 deletions kotlin/api/htmlMultiModule/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,28 +181,6 @@ <h2 class="">All modules:</h2>
<div><span class="brief-comment"></span></div>
</div>
</div>
<a data-name="-460263403%2FMain%2F0" anchor-label="workflow-ui-container-android" id="-460263403%2FMain%2F0" data-filterable-set=""></a>
<div class="table-row">
<div class="main-subrow ">
<div class="w-100"><span class="inline-flex">
<div><a href="workflow-ui/container-android/index.html">workflow-ui-container-android</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-460263403%2FMain%2F0"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div><span class="brief-comment"></span></div>
</div>
</div>
<a data-name="-661205249%2FMain%2F0" anchor-label="workflow-ui-container-common-jvm" id="-661205249%2FMain%2F0" data-filterable-set=""></a>
<div class="table-row">
<div class="main-subrow ">
<div class="w-100"><span class="inline-flex">
<div><a href="workflow-ui/container-common/index.html">workflow-ui-container-common-jvm</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-661205249%2FMain%2F0"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div><span class="brief-comment"></span></div>
</div>
</div>
<a data-name="1933990153%2FMain%2F0" anchor-label="workflow-ui-core-android" id="1933990153%2FMain%2F0" data-filterable-set=""></a>
<div class="table-row">
<div class="main-subrow ">
Expand Down Expand Up @@ -240,7 +218,7 @@ <h2 class="">All modules:</h2>
</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
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
Expand Down
435 changes: 185 additions & 250 deletions kotlin/api/htmlMultiModule/navigation.html

Large diffs are not rendered by default.

8 changes: 2 additions & 6 deletions kotlin/api/htmlMultiModule/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,12 @@ module:workflow-ui-compose
com.squareup.workflow1.ui.compose
module:workflow-ui-compose-tooling
com.squareup.workflow1.ui.compose.tooling
module:workflow-ui-container-android
com.squareup.workflow1.ui.modal
module:workflow-ui-container-common-jvm
com.squareup.workflow1.ui.backstack
module:workflow-ui-core-android
com.squareup.workflow1.ui
com.squareup.workflow1.ui.androidx
com.squareup.workflow1.ui.container
com.squareup.workflow1.ui.navigation
module:workflow-ui-core-common-jvm
com.squareup.workflow1.ui
com.squareup.workflow1.ui.container
com.squareup.workflow1.ui.navigation
module:workflow-ui-radiography
com.squareup.workflow1.ui.radiography
2 changes: 1 addition & 1 deletion kotlin/api/htmlMultiModule/scripts/pages.json

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h1 class="cover"><span>elapsed</span><wbr><span><span>Now</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":trace-encoder:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="elapsed-now.html">elapsedNow</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/square/workflow-kotlin/blob/main/trace-encoder/src/main/java/com/squareup/tracing/TimeMark.kt#L14">source</a>)</span></span></div><p class="paragraph">Returns the amount of time passed from this mark measured with the time source from which this mark was taken.</p><p class="paragraph">Note that the content of this val can change on subsequent invocations.</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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2 class="">Properties</h2>
</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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h1 class="cover"><span>Trace</span><wbr><span><span>Encoder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":trace-encoder:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><a href="../-time-mark/index.html">TimeMark</a><span class="token operator"> = </span>TraceEncoderTimeMark<span class="token punctuation">, </span></span><span class="parameter ">ioDispatcher<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span><span class="token operator"> = </span>IO<span class="token punctuation">, </span></span><span class="parameter ">sinkProvider<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><span data-unresolved-link="okio/BufferedSink///PointingToDeclaration/">BufferedSink</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/square/workflow-kotlin/blob/main/trace-encoder/src/main/java/com/squareup/tracing/TraceEncoder.kt#L30">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":trace-encoder:dokkaHtmlPartial/main" data-filterable-set=":trace-encoder:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>scope</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> that defines the lifetime for the encoder. When the scope is cancelled or fails, the sink returned from <a href="../../../trace-encoder/com.squareup.tracing/-trace-encoder/[60]init[62].html">sinkProvider</a> will be closed.</p></div></div></div></div><div class="table-row" data-filterable-current=":trace-encoder:dokkaHtmlPartial/main" data-filterable-set=":trace-encoder:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>start</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <a href="../-time-mark/index.html">TimeMark</a> to consider the beginning timestamp of the trace. All trace events' timestamps are relative to this mark. <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-time-source/-monotonic/index.html">TimeSource.Monotonic</a>.<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-time-source/-monotonic/mark-now.html">markNow</a> by default.</p></div></div></div></div><div class="table-row" data-filterable-current=":trace-encoder:dokkaHtmlPartial/main" data-filterable-set=":trace-encoder:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>io</span><wbr><span><span>Dispatcher</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span> to use to execute all IO operations. <span data-unresolved-link="kotlinx.coroutines/Dispatchers/IO/#/PointingToDeclaration/">IO</span> by default.</p></div></div></div></div><div class="table-row" data-filterable-current=":trace-encoder:dokkaHtmlPartial/main" data-filterable-set=":trace-encoder:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>sink</span><wbr><span><span>Provider</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Returns the <span data-unresolved-link="okio/BufferedSink///PointingToDeclaration/">BufferedSink</span> to use to write trace events to. Called on a background thread.</p></div></div></div></div></div></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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h1 class="cover"><span><span>close</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":trace-encoder:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/square/workflow-kotlin/blob/main/trace-encoder/src/main/java/com/squareup/tracing/TraceEncoder.kt#L87">source</a>)</span></span></div></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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h1 class="cover"><span>create</span><wbr><span><span>Logger</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":trace-encoder:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-logger.html"><span class="token function">createLogger</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">processName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">""</span><span class="token punctuation">, </span></span><span class="parameter ">threadName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">""</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-trace-logger/index.html">TraceLogger</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/square/workflow-kotlin/blob/main/trace-encoder/src/main/java/com/squareup/tracing/TraceEncoder.kt#L64">source</a>)</span></span></div><p class="paragraph">Allocates a new thread ID named <a href="create-logger.html">threadName</a> and returns a <a href="../-trace-logger/index.html">TraceLogger</a> that will log all events under that thread ID.</p><p class="paragraph">Note this does not do anything with <i>actual</i> threads, it just affects the thread ID used in trace events.</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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 94885ae

Please sign in to comment.