Skip to content

Commit

Permalink
Fix documentation for KoverReportExtension
Browse files Browse the repository at this point in the history
  • Loading branch information
@shanshin
shanshin committed May 29, 2023
1 parent b951af4 commit cba0635
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion ...adle -plugin/kotlinx.kover.gradle.plugin.dsl/-kover-report-extension/android-reports.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<div class="cover ">
<h1 class="cover"><span>android</span><wbr></wbr><span><span>Reports</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">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="android-reports.html"><span class="token function">androidReports</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">variant<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="org.gradle.api/Action///PointingToDeclaration/">Action</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-kover-reports-config/index.html">KoverReportsConfig</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Configure reports for classes of specified Android build variant.</p><p class="paragraph">example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">kover {<br> androidReports(&quot;debug&quot;) {<br> filters {<br> // override report filters for reports of 'debug' Android build variant<br> }<br><br> html {<br> // configure HTML report for 'debug' Android build variant<br> }<br><br> xml {<br> // configure XML report for 'debug' Android build variant<br> }<br><br> verify {<br> // configure coverage verification for 'debug' Android build variant<br> }<br> }<br>}</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 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">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="android-reports.html"><span class="token function">androidReports</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">variant<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="org.gradle.api/Action///PointingToDeclaration/">Action</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-kover-reports-config/index.html">KoverReportsConfig</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Configure reports for classes of specified Android build variant.</p><p class="paragraph">example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">koverReport {<br> androidReports(&quot;debug&quot;) {<br> filters {<br> // override report filters for reports of 'debug' Android build variant<br> }<br><br> html {<br> // configure HTML report for 'debug' Android build variant<br> }<br><br> xml {<br> // configure XML report for 'debug' Android build variant<br> }<br><br> verify {<br> // configure coverage verification for 'debug' Android build variant<br> }<br> }<br>}</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>© 2023 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion ...ver -gradle -plugin/kotlinx.kover.gradle.plugin.dsl/-kover-report-extension/defaults.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<div class="cover ">
<h1 class="cover"><span><span>defaults</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">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="defaults.html"><span class="token function">defaults</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="org.gradle.api/Action///PointingToDeclaration/">Action</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-kover-default-reports-config/index.html">KoverDefaultReportsConfig</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Configure reports for classes from Kotlin/JVM or Kotlin/MPP projects. Also content from specified Android build variant can be added by calling <code class="lang-kotlin">mergeWith</code>.</p><p class="paragraph">example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">kover {<br> defaults {<br> // add content of reports for specified variant to default reports<br> mergeWith(&quot;buildVariant&quot;)<br><br> filters {<br> // override report filters for default reports<br> }<br><br> html {<br> // configure default HTML report<br> }<br><br> xml {<br> // configure default XML report<br> }<br><br> verify {<br> // configure default coverage verification<br> }<br> }<br>}</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 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">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="defaults.html"><span class="token function">defaults</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="org.gradle.api/Action///PointingToDeclaration/">Action</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-kover-default-reports-config/index.html">KoverDefaultReportsConfig</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Configure reports for classes from Kotlin/JVM or Kotlin/MPP projects. Also content from specified Android build variant can be added by calling <code class="lang-kotlin">mergeWith</code>.</p><p class="paragraph">example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">koverReport {<br> defaults {<br> // add content of reports for specified variant to default reports<br> mergeWith(&quot;buildVariant&quot;)<br><br> filters {<br> // override report filters for default reports<br> }<br><br> html {<br> // configure default HTML report<br> }<br><br> xml {<br> // configure default XML report<br> }<br><br> verify {<br> // configure default coverage verification<br> }<br> }<br>}</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>© 2023 Copyright</span><span
Expand Down
4 changes: 2 additions & 2 deletions src/main/kotlin/kotlinx/kover/gradle/plugin/dsl/KoverReportExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public interface KoverReportExtension {
*
* example:
* ```
* kover {
* koverReport {
* defaults {
* // add content of reports for specified variant to default reports
* mergeWith("buildVariant")
Expand Down Expand Up @@ -119,7 +119,7 @@ public interface KoverReportExtension {
*
* example:
* ```
* kover {
* koverReport {
* androidReports("debug") {
* filters {
* // override report filters for reports of 'debug' Android build variant
Expand Down

0 comments on commit cba0635

Please sign in to comment.