Skip to content

Commit

Permalink
document thrown exceptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamkobor
adamkobor committed Jan 17, 2024
1 parent cc3a813 commit 91f0f2e
Show file tree
Hide file tree
Showing 29 changed files with 33 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.cast/cast-as.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.cast/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.cast/map-to.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/as-flow-of.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/await-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/await-first-or-null.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/await-first.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/await-list-of-firsts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/lovely-jooq/ls.jooq.execute/create.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand All @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>create</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/main"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create.html">R</a><span class="token operator"> : </span><span data-unresolved-link="org.jooq/UpdatableRecord///PointingToDeclaration/">UpdatableRecord</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create.html">R</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><span data-unresolved-link="org.jooq/DSLContext///PointingToDeclaration/">DSLContext</span><span class="token punctuation">.</span><a href="create.html"><span class="token function">create</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">init<span class="token operator">: </span><span class="token keyword"></span><a href="create.html">R</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="create.html">R</a></div><p class="paragraph">Creates a record of the given type and inserts it into the DB.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the inserted record</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>R</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type of the record</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>init</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a function to modify the record before insertion</p></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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create.html">R</a><span class="token operator"> : </span><span data-unresolved-link="org.jooq/UpdatableRecord///PointingToDeclaration/">UpdatableRecord</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create.html">R</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><span data-unresolved-link="org.jooq/DSLContext///PointingToDeclaration/">DSLContext</span><span class="token punctuation">.</span><a href="create.html"><span class="token function">create</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">init<span class="token operator">: </span><span class="token keyword"></span><a href="create.html">R</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="create.html">R</a></div><p class="paragraph">Creates a record of the given type and inserts it into the DB.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the inserted record</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>R</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type of the record</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>init</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a function to modify the record before insertion</p></div></div></div></div></div><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html"><span>Illegal</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if the record has no default 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
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/update-and-execute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.execute/update-if-changed-and-execute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/as-t-s-field.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/contained-in.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/minus-days.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/minus-months.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/plus-days.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/plus-months.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.field/regexp-matches.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.prepare/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/lovely-jooq/ls.jooq.prepare/insert.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
908915c.dirty </div>
cc3a813.dirty </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
Expand Down
Loading

0 comments on commit 91f0f2e

Please sign in to comment.