aboutsummaryrefslogtreecommitdiff
path: root/core/testdata/format/website
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2016-04-01 16:30:47 +0200
committerDmitry Jemerov <yole@jetbrains.com>2016-04-01 16:30:47 +0200
commit68318a6e3960ffb965b77ca66e9e28ad6ea06442 (patch)
treef031aac23e4caf2579843133cdc5c48882b4066e /core/testdata/format/website
parent011019a20eec1de2bdc699ca81e5465db8d543a9 (diff)
downloaddokka-68318a6e3960ffb965b77ca66e9e28ad6ea06442.tar.gz
dokka-68318a6e3960ffb965b77ca66e9e28ad6ea06442.tar.bz2
dokka-68318a6e3960ffb965b77ca66e9e28ad6ea06442.zip
KT-11329: improve formatting of KDoc sections
Diffstat (limited to 'core/testdata/format/website')
-rw-r--r--core/testdata/format/website/returnTag.kt11
-rw-r--r--core/testdata/format/website/returnTag.md25
2 files changed, 36 insertions, 0 deletions
diff --git a/core/testdata/format/website/returnTag.kt b/core/testdata/format/website/returnTag.kt
new file mode 100644
index 00000000..669c14f9
--- /dev/null
+++ b/core/testdata/format/website/returnTag.kt
@@ -0,0 +1,11 @@
+class Foo
+
+/**
+ * Returns the index within this string of the first occurrence of the specified character, starting from the specified [startIndex].
+ *
+ * @param ignoreCase `true` to ignore character case when matching a character. By default `false`.
+ * @returns An index of the first occurrence of [char] or -1 if none is found.
+ */
+fun Foo.indexOf(char: Char, startIndex: Int = 0, ignoreCase: Boolean = false): Int {
+ return -1
+}
diff --git a/core/testdata/format/website/returnTag.md b/core/testdata/format/website/returnTag.md
new file mode 100644
index 00000000..301635ad
--- /dev/null
+++ b/core/testdata/format/website/returnTag.md
@@ -0,0 +1,25 @@
+---
+title: indexOf - test
+layout: api
+---
+
+<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/index-of">indexOf</a></div>
+
+
+# indexOf
+
+<div class="signature"><code><span class="keyword">fun </span><a href="test/-foo/index"><span class="identifier">Foo</span></a><span class="symbol">.</span><span class="identifier">indexOf</span><span class="symbol">(</span><br/>&nbsp;&nbsp;&nbsp;&nbsp;<span class="parameterName">char</span><span class="symbol">:</span>&nbsp;<span class="identifier">Char</span><span class="symbol">, </span><br/>&nbsp;&nbsp;&nbsp;&nbsp;<span class="parameterName">startIndex</span><span class="symbol">:</span>&nbsp;<span class="identifier">Int</span>&nbsp;<span class="symbol">=</span>&nbsp;0<span class="symbol">, </span><br/>&nbsp;&nbsp;&nbsp;&nbsp;<span class="parameterName">ignoreCase</span><span class="symbol">:</span>&nbsp;<span class="identifier">Boolean</span>&nbsp;<span class="symbol">=</span>&nbsp;false<br/><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code><br/>
+</div>
+
+Returns the index within this string of the first occurrence of the specified character, starting from the specified <a href="test/index-of#$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/startIndex">startIndex</a>.
+
+
+### Parameters
+
+<code>ignoreCase</code> - <code>true</code> to ignore character case when matching a character. By default <code>false</code>.
+
+**Returns**
+An index of the first occurrence of <a href="test/index-of#$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/char">char</a> or -1 if none is found.
+
+
+