Skip to content

Commit

Permalink
Deploying to site from @ 4bace2b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWharton committed Feb 16, 2024
1 parent 4cf96cc commit 69afd9f
Show file tree
Hide file tree
Showing 10 changed files with 410 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<div class="breadcrumbs"><a href="../../index.html">redwood-schema</a><span class="delimiter">/</span><a href="../index.html">app.cash.redwood.schema</a><span class="delimiter">/</span><span class="current">Schema</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Schema</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":redwood-schema:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html">AnnotationTarget.CLASS</a></span><wbr><span class="token punctuation">]</span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">annotation class </span><a href="index.html">Schema</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>members<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>dependencies<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-dependency/index.html">Schema.Dependency</a><span class="token operator">&gt;</span><span class="token operator"> = </span>[]</span></span><span class="token punctuation">)</span></div><p class="paragraph">Annotates an otherwise unused type with a set of <a href="../-widget/index.html">Widget</a>-annotated or <a href="../-modifier/index.html">Modifier</a>-annotated classes which are all part of this schema.</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">@Schema([<br> Row::class,<br> RowAlignment::class,<br> Button::class,<br> Text::class,<br>])<br>interface Name</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-widget/index.html"><span><span>Widget</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-modifier/index.html"><span><span>Modifier</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":redwood-schema:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html">AnnotationTarget.CLASS</a></span><wbr><span class="token punctuation">]</span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">annotation class </span><a href="index.html">Schema</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>members<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>dependencies<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-dependency/index.html">Schema.Dependency</a><span class="token operator">&gt;</span><span class="token operator"> = </span>[]<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>reservedWidgets<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token operator"> = </span>[]<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>reservedModifiers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token operator"> = </span>[]</span></span><span class="token punctuation">)</span></div><p class="paragraph">Annotates an otherwise unused type with a set of <a href="../-widget/index.html">Widget</a>-annotated or <a href="../-modifier/index.html">Modifier</a>-annotated classes which are all part of this schema.</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">@Schema([<br> Row::class,<br> RowAlignment::class,<br> Button::class,<br> Text::class,<br>])<br>interface Name</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-widget/index.html"><span><span>Widget</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-modifier/index.html"><span><span>Modifier</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down Expand Up @@ -118,6 +118,36 @@ <h2 class="">Properties</h2>
</div>
</div>
</div>
<a data-name="-1691895129%2FProperties%2F163200184" anchor-label="reservedModifiers" id="-1691895129%2FProperties%2F163200184" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reserved-modifiers.html"><span>reserved</span><wbr><span><span>Modifiers</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1691895129%2FProperties%2F163200184"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</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=":redwood-schema:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="reserved-modifiers.html">reservedModifiers</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a></div><div class="brief "><p class="paragraph">Modifier tags which are reserved. These cannot be used by a modifier in <a href="members.html">members</a>. This is useful for ensuring tags from old, retired modifiers are not accidentally reused.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1906690732%2FProperties%2F163200184" anchor-label="reservedWidgets" id="-1906690732%2FProperties%2F163200184" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":redwood-schema:dokkaHtmlPartial/main" data-filterable-set=":redwood-schema:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reserved-widgets.html"><span>reserved</span><wbr><span><span>Widgets</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1906690732%2FProperties%2F163200184"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</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=":redwood-schema:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="reserved-widgets.html">reservedWidgets</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a></div><div class="brief "><p class="paragraph">Widget tags which are reserved. These cannot be used by a widget in <a href="members.html">members</a>. This is useful for ensuring tags from old, retired widgets are not accidentally reused.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>reservedModifiers</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
redwood
</a> </div>
<div class="library-version">0.8.0-SNAPSHOT
</div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":redwood-schema:dokkaHtmlPartial/main">jvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="redwood-schema::app.cash.redwood.schema/Schema/reservedModifiers/#/PointingToDeclaration//163200184">
<div class="breadcrumbs"><a href="../../index.html">redwood-schema</a><span class="delimiter">/</span><a href="../index.html">app.cash.redwood.schema</a><span class="delimiter">/</span><a href="index.html">Schema</a><span class="delimiter">/</span><span class="current">reservedModifiers</span></div>
<div class="cover ">
<h1 class="cover"><span>reserved</span><wbr><span><span>Modifiers</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":redwood-schema:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="reserved-modifiers.html">reservedModifiers</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a></div><p class="paragraph">Modifier tags which are reserved. These cannot be used by a modifier in <a href="members.html">members</a>. This is useful for ensuring tags from old, retired modifiers are not accidentally reused.</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">@Schema(<br> members = [<br> Row::class,<br> Button::class,<br> Text::class,<br> ],<br> reservedModifiers = [<br> 3, // Retired RowAlignment modifier.<br> ],<br>)<br>interface MySchema</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></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>© 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>
</div>
</body>
</html>

Loading

0 comments on commit 69afd9f

Please sign in to comment.