From 68318a6e3960ffb965b77ca66e9e28ad6ea06442 Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Fri, 1 Apr 2016 16:30:47 +0200 Subject: KT-11329: improve formatting of KDoc sections --- core/testdata/format/website/returnTag.kt | 11 +++++++++++ core/testdata/format/website/returnTag.md | 25 +++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 core/testdata/format/website/returnTag.kt create mode 100644 core/testdata/format/website/returnTag.md (limited to 'core/testdata/format/website') 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 +--- + +
test / indexOf
+ + +# indexOf + +
fun Foo.indexOf(
    char: Char,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Int

+
+ +Returns the index within this string of the first occurrence of the specified character, starting from the specified startIndex. + + +### Parameters + +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. + + + -- cgit