Skip to content

Commit

Permalink
Deploying to gh-pages from @ 848e6cf 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Egorand committed Jan 12, 2024
1 parent eeb8f55 commit 22e3668
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,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=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-taggable/tag.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </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 keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </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 keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-taggable/tag.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FileSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,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=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-taggable/tag.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </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 keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </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 keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#kotlin.reflect.KClass[TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/">T</span><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="../-taggable/tag.html"><span class="token function">tag</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-taggable/tag.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToGenericParameters(0)/">T</span><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Returns the tag attached with <span data-unresolved-link="com.squareup.kotlinpoet/FunSpec/tag/#[Error type: Unresolved type for Class&amp;lt;T&amp;gt;][TypeParam(bounds=[kotlin.Any])]/PointingToCallableParameters(0)/">type</span> as a key, or null if no tag is attached with that key.</p></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span>Name</span><wbr></wbr><span><span>Allocator</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><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=":kotlinpoet:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div><br><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">preallocateKeywords<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kotlinpoet:dokkaHtml/commonMain" data-filterable-set=":kotlinpoet:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>preallocate</span><wbr></wbr><span><span>Keywords</span></span></u></div></span></div><div><div class="title"><p class="paragraph">If true, all Kotlin keywords will be preallocated. Requested names which collide with keywords will be suffixed with underscores to avoid being used as identifiers:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">val nameAllocator = NameAllocator(preallocateKeywords = true)<br>println(nameAllocator.newName(&quot;when&quot;)) // prints &quot;when_&quot;</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><p class="paragraph">If false, keywords will not get any special treatment:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">val nameAllocator = NameAllocator(preallocateKeywords = false)<br>println(nameAllocator.newName(&quot;when&quot;)) // prints &quot;when&quot;</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><p class="paragraph">Note that you can use the <code class="lang-kotlin">%N</code> placeholder when emitting a name produced by <a href="index.html">NameAllocator</a> to ensure it's properly escaped for use as an identifier:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">val nameAllocator = NameAllocator(preallocateKeywords = false)<br>println(CodeBlock.of(&quot;%N&quot;, nameAllocator.newName(&quot;when&quot;))) // prints &quot;`when`&quot;</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><p class="paragraph">The default behaviour of <a href="index.html">NameAllocator</a> is to preallocate keywords - this is the behaviour you'll get when using the no-arg constructor.</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>© 2024 Copyright</span><span
Expand Down
Loading

0 comments on commit 22e3668

Please sign in to comment.