diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-02-09 03:15:52 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-09 03:15:52 +0100 |
| commit | 7546efb83afa39770be5c7b9df72edc115e59a5b (patch) | |
| tree | 0066c2b9e833e7dd7fd8cfafc3a1d05d15f40000 /core | |
| parent | 683f6bb418bada9c90d2ffbd5040b3968e1c3522 (diff) | |
| download | dokka-7546efb83afa39770be5c7b9df72edc115e59a5b.tar.gz dokka-7546efb83afa39770be5c7b9df72edc115e59a5b.tar.bz2 dokka-7546efb83afa39770be5c7b9df72edc115e59a5b.zip | |
Remove old test data (#2824)
Diffstat (limited to 'core')
437 files changed, 0 insertions, 11592 deletions
diff --git a/core/testdata/classes/annotatedClass.kt b/core/testdata/classes/annotatedClass.kt deleted file mode 100644 index 1b58f56c..00000000 --- a/core/testdata/classes/annotatedClass.kt +++ /dev/null @@ -1 +0,0 @@ -@Strictfp class Foo() {} diff --git a/core/testdata/classes/annotatedClassWithAnnotationParameters.kt b/core/testdata/classes/annotatedClassWithAnnotationParameters.kt deleted file mode 100644 index 930d6a62..00000000 --- a/core/testdata/classes/annotatedClassWithAnnotationParameters.kt +++ /dev/null @@ -1 +0,0 @@ -@Deprecated("should no longer be used") class Foo() {} diff --git a/core/testdata/classes/classWithCompanionObject.kt b/core/testdata/classes/classWithCompanionObject.kt deleted file mode 100644 index fdbd915d..00000000 --- a/core/testdata/classes/classWithCompanionObject.kt +++ /dev/null @@ -1,7 +0,0 @@ -class Klass() { - companion object { - val x = 1 - - fun foo() {} - } -} diff --git a/core/testdata/classes/classWithConstructor.kt b/core/testdata/classes/classWithConstructor.kt deleted file mode 100644 index 0751d570..00000000 --- a/core/testdata/classes/classWithConstructor.kt +++ /dev/null @@ -1 +0,0 @@ -class Klass(name: String)
\ No newline at end of file diff --git a/core/testdata/classes/classWithFunction.kt b/core/testdata/classes/classWithFunction.kt deleted file mode 100644 index a981cfb6..00000000 --- a/core/testdata/classes/classWithFunction.kt +++ /dev/null @@ -1,4 +0,0 @@ -class Klass { - fun fn() { - } -} diff --git a/core/testdata/classes/classWithProperty.kt b/core/testdata/classes/classWithProperty.kt deleted file mode 100644 index 2a849572..00000000 --- a/core/testdata/classes/classWithProperty.kt +++ /dev/null @@ -1,3 +0,0 @@ -class Klass { - val name: String = "" -}
\ No newline at end of file diff --git a/core/testdata/classes/companionObjectExtension.kt b/core/testdata/classes/companionObjectExtension.kt deleted file mode 100644 index 4b471376..00000000 --- a/core/testdata/classes/companionObjectExtension.kt +++ /dev/null @@ -1,10 +0,0 @@ -class Foo { - companion object Default { - } -} - - -/** - * The def - */ -val Foo.Default.x: Int get() = 1 diff --git a/core/testdata/classes/dataClass.kt b/core/testdata/classes/dataClass.kt deleted file mode 100644 index 62c6f0ec..00000000 --- a/core/testdata/classes/dataClass.kt +++ /dev/null @@ -1 +0,0 @@ -data class Foo() {} diff --git a/core/testdata/classes/emptyClass.kt b/core/testdata/classes/emptyClass.kt deleted file mode 100644 index abd20cc8..00000000 --- a/core/testdata/classes/emptyClass.kt +++ /dev/null @@ -1,3 +0,0 @@ -class Klass { - -}
\ No newline at end of file diff --git a/core/testdata/classes/emptyObject.kt b/core/testdata/classes/emptyObject.kt deleted file mode 100644 index 4138bf31..00000000 --- a/core/testdata/classes/emptyObject.kt +++ /dev/null @@ -1,3 +0,0 @@ -object Obj { - -}
\ No newline at end of file diff --git a/core/testdata/classes/genericClass.kt b/core/testdata/classes/genericClass.kt deleted file mode 100644 index db20ff7e..00000000 --- a/core/testdata/classes/genericClass.kt +++ /dev/null @@ -1,3 +0,0 @@ -class Klass<T> { - -}
\ No newline at end of file diff --git a/core/testdata/classes/indirectOverride.kt b/core/testdata/classes/indirectOverride.kt deleted file mode 100644 index 8d091b80..00000000 --- a/core/testdata/classes/indirectOverride.kt +++ /dev/null @@ -1,9 +0,0 @@ -abstract class C() { - abstract fun foo() -} - -abstract class D(): C() - -class E(): D() { - override fun foo() {} -} diff --git a/core/testdata/classes/innerClass.kt b/core/testdata/classes/innerClass.kt deleted file mode 100644 index 3c6e497d..00000000 --- a/core/testdata/classes/innerClass.kt +++ /dev/null @@ -1,5 +0,0 @@ -class C { - inner class D { - - } -}
\ No newline at end of file diff --git a/core/testdata/classes/javaAnnotationClass.kt b/core/testdata/classes/javaAnnotationClass.kt deleted file mode 100644 index 95600147..00000000 --- a/core/testdata/classes/javaAnnotationClass.kt +++ /dev/null @@ -1,5 +0,0 @@ -import java.lang.annotation.Retention -import java.lang.annotation.RetentionPolicy - -@Retention(RetentionPolicy.SOURCE) -public annotation class throws() diff --git a/core/testdata/classes/notOpenClass.kt b/core/testdata/classes/notOpenClass.kt deleted file mode 100644 index edee2c1a..00000000 --- a/core/testdata/classes/notOpenClass.kt +++ /dev/null @@ -1,7 +0,0 @@ -open class C() { - open fun f() {} -} - -class D() : C() { - override fun f() {} -} diff --git a/core/testdata/classes/privateCompanionObject.kt b/core/testdata/classes/privateCompanionObject.kt deleted file mode 100644 index df43b5f9..00000000 --- a/core/testdata/classes/privateCompanionObject.kt +++ /dev/null @@ -1,11 +0,0 @@ -package p - -class Clz { - private companion object { - fun fuun() { - - } - - val aaaa = 0 - } -}
\ No newline at end of file diff --git a/core/testdata/classes/sealedClass.kt b/core/testdata/classes/sealedClass.kt deleted file mode 100644 index 93350393..00000000 --- a/core/testdata/classes/sealedClass.kt +++ /dev/null @@ -1 +0,0 @@ -sealed class Foo() {} diff --git a/core/testdata/classes/secondaryConstructor.kt b/core/testdata/classes/secondaryConstructor.kt deleted file mode 100644 index e5cb2557..00000000 --- a/core/testdata/classes/secondaryConstructor.kt +++ /dev/null @@ -1,5 +0,0 @@ -class C() { - /** This is a secondary constructor. */ - constructor(s: String): this() { - } -} diff --git a/core/testdata/classes/sinceKotlin.kt b/core/testdata/classes/sinceKotlin.kt deleted file mode 100644 index 1025cf0d..00000000 --- a/core/testdata/classes/sinceKotlin.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Useful - */ -@SinceKotlin("1.1") -class `Since1.1`
\ No newline at end of file diff --git a/core/testdata/comments/codeBlockComment.kt b/core/testdata/comments/codeBlockComment.kt deleted file mode 100644 index aa5f5ffc..00000000 --- a/core/testdata/comments/codeBlockComment.kt +++ /dev/null @@ -1,14 +0,0 @@ -/** - * ``` brainfuck - * ++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>. - * ``` - */ -val prop1 = "" - - -/** - * ``` - * a + b - c - * ``` - */ -val prop2 = ""
\ No newline at end of file diff --git a/core/testdata/comments/directive.kt b/core/testdata/comments/directive.kt deleted file mode 100644 index b27f5a48..00000000 --- a/core/testdata/comments/directive.kt +++ /dev/null @@ -1,35 +0,0 @@ -/** - * Summary - * - * @sample example1 - * @sample example2 - * @sample X.example3 - * @sample X.Y.example4 - */ -val property = "test" - -fun example1(node: String) = if (true) { - println(property) -} - -fun example2(node: String) { - if (true) { - println(property) - } -} - -class X { - fun example3(node: String) { - if (true) { - println(property) - } - } - - class Y { - fun example4(node: String) { - if (true) { - println(property) - } - } - } -} diff --git a/core/testdata/comments/emptyDoc.kt b/core/testdata/comments/emptyDoc.kt deleted file mode 100644 index b87cce57..00000000 --- a/core/testdata/comments/emptyDoc.kt +++ /dev/null @@ -1 +0,0 @@ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/emptyDocButComment.kt b/core/testdata/comments/emptyDocButComment.kt deleted file mode 100644 index ceb24753..00000000 --- a/core/testdata/comments/emptyDocButComment.kt +++ /dev/null @@ -1,2 +0,0 @@ -/* comment */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/emptySection.kt b/core/testdata/comments/emptySection.kt deleted file mode 100644 index 47d6b1a5..00000000 --- a/core/testdata/comments/emptySection.kt +++ /dev/null @@ -1,6 +0,0 @@ - -/** - * Summary - * @one - */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/multilineDoc.kt b/core/testdata/comments/multilineDoc.kt deleted file mode 100644 index 31cfa3a7..00000000 --- a/core/testdata/comments/multilineDoc.kt +++ /dev/null @@ -1,7 +0,0 @@ -/** - * doc1 - * - * doc2 - * doc3 - */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/multilineDocWithComment.kt b/core/testdata/comments/multilineDocWithComment.kt deleted file mode 100644 index 88d22642..00000000 --- a/core/testdata/comments/multilineDocWithComment.kt +++ /dev/null @@ -1,8 +0,0 @@ -/** - * doc1 - * - * doc2 - * doc3 - */ -// comment -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/multilineSection.kt b/core/testdata/comments/multilineSection.kt deleted file mode 100644 index 6ef4df2c..00000000 --- a/core/testdata/comments/multilineSection.kt +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Summary - * @one - * line one - * line two - */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/oneLineDoc.kt b/core/testdata/comments/oneLineDoc.kt deleted file mode 100644 index 92a40c67..00000000 --- a/core/testdata/comments/oneLineDoc.kt +++ /dev/null @@ -1,2 +0,0 @@ -/** doc */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/oneLineDocWithComment.kt b/core/testdata/comments/oneLineDocWithComment.kt deleted file mode 100644 index c8467933..00000000 --- a/core/testdata/comments/oneLineDocWithComment.kt +++ /dev/null @@ -1,3 +0,0 @@ -/** doc */ -// comment -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/oneLineDocWithEmptyLine.kt b/core/testdata/comments/oneLineDocWithEmptyLine.kt deleted file mode 100644 index e364c416..00000000 --- a/core/testdata/comments/oneLineDocWithEmptyLine.kt +++ /dev/null @@ -1,3 +0,0 @@ -/** doc */ - -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/quotes.kt b/core/testdata/comments/quotes.kt deleted file mode 100644 index 47ae6892..00000000 --- a/core/testdata/comments/quotes.kt +++ /dev/null @@ -1,2 +0,0 @@ -/** it's "useful" */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/section1.kt b/core/testdata/comments/section1.kt deleted file mode 100644 index 7c763b4c..00000000 --- a/core/testdata/comments/section1.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Summary - * @one section one - */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/comments/section2.kt b/core/testdata/comments/section2.kt deleted file mode 100644 index e280793e..00000000 --- a/core/testdata/comments/section2.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Summary - * @one section one - * @two section two - */ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/format/JavaSupertype.html b/core/testdata/format/JavaSupertype.html deleted file mode 100644 index 85fb6d84..00000000 --- a/core/testdata/format/JavaSupertype.html +++ /dev/null @@ -1,36 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>JavaSupertype.Bar - test</title> -</HEAD> -<BODY> -<a href="../../../index.html">test</a> / <a href="../index.html">JavaSupertype</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Bar</span> <span class="symbol">:</span> <a href="../-foo/index.html"><span class="identifier">JavaSupertype.Foo</span></a></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="return-foo.html">returnFoo</a></h4> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">returnFoo</span><span class="symbol">(</span><span class="identifier" id="JavaSupertype.Bar$returnFoo(JavaSupertype.Foo)/foo">foo</span><span class="symbol">:</span> <a href="../-foo/index.html"><span class="identifier">JavaSupertype.Foo</span></a><span class="symbol">!</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-foo/index.html"><span class="identifier">JavaSupertype.Foo</span></a><span class="symbol">!</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/JavaSupertype.java b/core/testdata/format/JavaSupertype.java deleted file mode 100644 index 2045573c..00000000 --- a/core/testdata/format/JavaSupertype.java +++ /dev/null @@ -1,8 +0,0 @@ -public class JavaSupertype { - public static class Foo { - } - - public static class Bar extends Foo { - public Foo returnFoo(Foo foo) { return foo; } - } -} diff --git a/core/testdata/format/accessor.kt b/core/testdata/format/accessor.kt deleted file mode 100644 index 5a4d1742..00000000 --- a/core/testdata/format/accessor.kt +++ /dev/null @@ -1,5 +0,0 @@ -class C() { - var x: String - /** The getter returns an empty string. */ get() = "" - /** The setter does nothing. */ set(value) { } -} diff --git a/core/testdata/format/accessor.md b/core/testdata/format/accessor.md deleted file mode 100644 index 9bb2c4ed..00000000 --- a/core/testdata/format/accessor.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [C](index.md) / [x](./x.md) - -# x - -`var x: String` - -**Getter** - -The getter returns an empty string. - -**Setter** - -The setter does nothing. - diff --git a/core/testdata/format/annotatedTypeParameter.kt b/core/testdata/format/annotatedTypeParameter.kt deleted file mode 100644 index cc3bfc1a..00000000 --- a/core/testdata/format/annotatedTypeParameter.kt +++ /dev/null @@ -1,2 +0,0 @@ -public fun <E> containsAll(elements: Collection<@UnsafeVariance E>): @UnsafeVariance E { -} diff --git a/core/testdata/format/annotatedTypeParameter.md b/core/testdata/format/annotatedTypeParameter.md deleted file mode 100644 index 36d8aba9..00000000 --- a/core/testdata/format/annotatedTypeParameter.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [containsAll](./contains-all.md) - -# containsAll - -`fun <E> containsAll(elements: Collection<@UnsafeVariance `[`E`](contains-all.md#E)`>): @UnsafeVariance `[`E`](contains-all.md#E)
\ No newline at end of file diff --git a/core/testdata/format/annotationClass.kt b/core/testdata/format/annotationClass.kt deleted file mode 100644 index 89d494fb..00000000 --- a/core/testdata/format/annotationClass.kt +++ /dev/null @@ -1 +0,0 @@ -annotation class fancy diff --git a/core/testdata/format/annotationClass.md b/core/testdata/format/annotationClass.md deleted file mode 100644 index 9ce4aea9..00000000 --- a/core/testdata/format/annotationClass.md +++ /dev/null @@ -1,10 +0,0 @@ -[test](../../index.md) / [fancy](./index.md) - -# fancy - -`annotation class fancy` - -### Constructors - -| [<init>](-init-.md) | `fancy()` | - diff --git a/core/testdata/format/annotationClass.package.md b/core/testdata/format/annotationClass.package.md deleted file mode 100644 index 25e0d77c..00000000 --- a/core/testdata/format/annotationClass.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Annotations - -| [fancy](fancy/index.md) | `annotation class fancy` | - diff --git a/core/testdata/format/annotationParams.kt b/core/testdata/format/annotationParams.kt deleted file mode 100644 index f259a740..00000000 --- a/core/testdata/format/annotationParams.kt +++ /dev/null @@ -1 +0,0 @@ -@JvmName("FFF") fun f() {} diff --git a/core/testdata/format/annotationParams.md b/core/testdata/format/annotationParams.md deleted file mode 100644 index 7388c83a..00000000 --- a/core/testdata/format/annotationParams.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`@JvmName("FFF") fun f(): Unit`
\ No newline at end of file diff --git a/core/testdata/format/annotations.kt b/core/testdata/format/annotations.kt deleted file mode 100644 index 57f76249..00000000 --- a/core/testdata/format/annotations.kt +++ /dev/null @@ -1,6 +0,0 @@ -data class Foo { - inline fun bar(noinline notInlined: () -> Unit) { - } - - inline val x: Int -} diff --git a/core/testdata/format/annotations.md b/core/testdata/format/annotations.md deleted file mode 100644 index 07c22103..00000000 --- a/core/testdata/format/annotations.md +++ /dev/null @@ -1,18 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`data class Foo` - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - -### Properties - -| [x](x.md) | `val x: Int` | - -### Functions - -| [bar](bar.md) | `fun bar(notInlined: () -> Unit): Unit` | - diff --git a/core/testdata/format/arrayAverage.kt b/core/testdata/format/arrayAverage.kt deleted file mode 100644 index 1f9e12db..00000000 --- a/core/testdata/format/arrayAverage.kt +++ /dev/null @@ -1,8 +0,0 @@ -class XArray<T> - -fun XArray<out Byte>.average(): Double = 0.0 -fun XArray<out Double>.average(): Double = 0.0 -fun XArray<out Float>.average(): Double = 0.0 -fun XArray<out Int>.average(): Double = 0.0 -fun XArray<out Long>.average(): Double = 0.0 -fun XArray<out Short>.average(): Double = 0.0 diff --git a/core/testdata/format/arrayAverage.md b/core/testdata/format/arrayAverage.md deleted file mode 100644 index 5867c1be..00000000 --- a/core/testdata/format/arrayAverage.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [XArray](./index.md) - -# XArray - -`class XArray<T>` - -### Constructors - -| [<init>](-init-.md) | `XArray()` | - -### Extension Functions - -| [average](../average.md) | `fun `[`XArray`](./index.md)`<out Byte>.average(): Double`<br>`fun `[`XArray`](./index.md)`<out Double>.average(): Double`<br>`fun `[`XArray`](./index.md)`<out Float>.average(): Double`<br>`fun `[`XArray`](./index.md)`<out Int>.average(): Double`<br>`fun `[`XArray`](./index.md)`<out Long>.average(): Double`<br>`fun `[`XArray`](./index.md)`<out Short>.average(): Double` | - diff --git a/core/testdata/format/backtickInCodeBlock.kt b/core/testdata/format/backtickInCodeBlock.kt deleted file mode 100644 index b457efbd..00000000 --- a/core/testdata/format/backtickInCodeBlock.kt +++ /dev/null @@ -1,9 +0,0 @@ -/** - * bt : `` ` `` - * - * bt+ : ``prefix ` postfix`` - * - * backslash: `\` - */ -fun foo() { -} diff --git a/core/testdata/format/backtickInCodeBlock.md b/core/testdata/format/backtickInCodeBlock.md deleted file mode 100644 index d2267204..00000000 --- a/core/testdata/format/backtickInCodeBlock.md +++ /dev/null @@ -1,12 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): Unit` - -bt : `` ` `` - -bt+ : ``prefix ` postfix`` - -backslash: `\` - diff --git a/core/testdata/format/blankLineInsideCodeBlock.html b/core/testdata/format/blankLineInsideCodeBlock.html deleted file mode 100644 index 9db7d4f0..00000000 --- a/core/testdata/format/blankLineInsideCodeBlock.html +++ /dev/null @@ -1,18 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>u - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./u.html">u</a><br/> -<br/> -<h1>u</h1> -<a name="$u()"></a> -<code><span class="keyword">fun </span><span class="identifier">u</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><pre><code>This is a test - of Dokka's code blocks. -Here is a blank line. - -The previous line was blank. -</code></pre> -</BODY> -</HTML> diff --git a/core/testdata/format/blankLineInsideCodeBlock.kt b/core/testdata/format/blankLineInsideCodeBlock.kt deleted file mode 100644 index 9430f4d5..00000000 --- a/core/testdata/format/blankLineInsideCodeBlock.kt +++ /dev/null @@ -1,12 +0,0 @@ -/** - * ``` - * This is a test - * of Dokka's code blocks. - * Here is a blank line. - * - * The previous line was blank. - * ``` - */ -fun u() { - -}
\ No newline at end of file diff --git a/core/testdata/format/blankLineInsideCodeBlock.md b/core/testdata/format/blankLineInsideCodeBlock.md deleted file mode 100644 index 1a3ef10e..00000000 --- a/core/testdata/format/blankLineInsideCodeBlock.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../index.md) / [u](./u.md) - -# u - -`fun u(): Unit` - -``` -This is a test - of Dokka's code blocks. -Here is a blank line. - -The previous line was blank. -``` - diff --git a/core/testdata/format/bracket.html b/core/testdata/format/bracket.html deleted file mode 100644 index 5ba19b73..00000000 --- a/core/testdata/format/bracket.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>bar[]</p> -</BODY> -</HTML> diff --git a/core/testdata/format/bracket.kt b/core/testdata/format/bracket.kt deleted file mode 100644 index d41b0073..00000000 --- a/core/testdata/format/bracket.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * bar[] - */ -fun foo() {} diff --git a/core/testdata/format/brokenLink.html b/core/testdata/format/brokenLink.html deleted file mode 100644 index db47c05a..00000000 --- a/core/testdata/format/brokenLink.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f()"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>This references <a href="#">noSuchIdentifier</a>.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/brokenLink.kt b/core/testdata/format/brokenLink.kt deleted file mode 100644 index 268a986e..00000000 --- a/core/testdata/format/brokenLink.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * This references [noSuchIdentifier]. - */ -fun f() { } diff --git a/core/testdata/format/classWithCompanionObject.html b/core/testdata/format/classWithCompanionObject.html deleted file mode 100644 index e477b53b..00000000 --- a/core/testdata/format/classWithCompanionObject.html +++ /dev/null @@ -1,48 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Klass - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Klass</a><br/> -<br/> -<h1>Klass</h1> -<code><span class="keyword">class </span><span class="identifier">Klass</span></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">Klass</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Companion Object Properties</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="x.html">x</a></h4> -</td> -<td> -<code><span class="keyword">val </span><span class="identifier">x</span><span class="symbol">: </span><span class="identifier">Int</span></code></td> -</tr> -</tbody> -</table> -<h3>Companion Object Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="foo.html">foo</a></h4> -</td> -<td> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/classWithCompanionObject.kt b/core/testdata/format/classWithCompanionObject.kt deleted file mode 100644 index fdbd915d..00000000 --- a/core/testdata/format/classWithCompanionObject.kt +++ /dev/null @@ -1,7 +0,0 @@ -class Klass() { - companion object { - val x = 1 - - fun foo() {} - } -} diff --git a/core/testdata/format/classWithCompanionObject.md b/core/testdata/format/classWithCompanionObject.md deleted file mode 100644 index 850e51ec..00000000 --- a/core/testdata/format/classWithCompanionObject.md +++ /dev/null @@ -1,18 +0,0 @@ -[test](../../index.md) / [Klass](./index.md) - -# Klass - -`class Klass` - -### Constructors - -| [<init>](-init-.md) | `Klass()` | - -### Companion Object Properties - -| [x](x.md) | `val x: Int` | - -### Companion Object Functions - -| [foo](foo.md) | `fun foo(): Unit` | - diff --git a/core/testdata/format/codeBlock.html b/core/testdata/format/codeBlock.html deleted file mode 100644 index ead4dbc0..00000000 --- a/core/testdata/format/codeBlock.html +++ /dev/null @@ -1,60 +0,0 @@ -<!-- File: test/--root--/-throws/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Throws - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Throws</a><br/> -<br/> -<h1>Throws</h1> -<code><span class="keyword">class </span><span class="identifier">Throws</span></code> -<p>This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.</p> -<p>Example:</p> -<pre><code>Throws(IOException::class) -fun readFile(name: String): String {...} -</code></pre> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.</p> -<code><span class="identifier">Throws</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> -<!-- File: test/--root--/-it-does-some-obfuscated-thing/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>ItDoesSomeObfuscatedThing - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">ItDoesSomeObfuscatedThing</a><br/> -<br/> -<h1>ItDoesSomeObfuscatedThing</h1> -<code><span class="keyword">class </span><span class="identifier">ItDoesSomeObfuscatedThing</span></code> -<p>Check output of</p> -<pre><code class="lang-brainfuck">++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>. -</code></pre> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Check output of</p> -<code><span class="identifier">ItDoesSomeObfuscatedThing</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/codeBlock.kt b/core/testdata/format/codeBlock.kt deleted file mode 100644 index 633bf414..00000000 --- a/core/testdata/format/codeBlock.kt +++ /dev/null @@ -1,22 +0,0 @@ -import kotlin.reflect.KClass - -/** - * This annotation indicates what exceptions should be declared by a function when compiled to a JVM method. - * - * Example: - * - * ``` - * Throws(IOException::class) - * fun readFile(name: String): String {...} - * ``` - */ -class Throws - - -/** - * Check output of - * ``` brainfuck - * ++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>. - * ``` - */ -class ItDoesSomeObfuscatedThing
\ No newline at end of file diff --git a/core/testdata/format/codeBlock.md b/core/testdata/format/codeBlock.md deleted file mode 100644 index c14fc7bd..00000000 --- a/core/testdata/format/codeBlock.md +++ /dev/null @@ -1,37 +0,0 @@ -<!-- File: test/--root--/-throws/index.md --> -[test](../../index.md) / [Throws](./index.md) - -# Throws - -`class Throws` - -This annotation indicates what exceptions should be declared by a function when compiled to a JVM method. - -Example: - -``` -Throws(IOException::class) -fun readFile(name: String): String {...} -``` - -### Constructors - -| [<init>](-init-.md) | This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.`Throws()` | - -<!-- File: test/--root--/-it-does-some-obfuscated-thing/index.md --> -[test](../../index.md) / [ItDoesSomeObfuscatedThing](./index.md) - -# ItDoesSomeObfuscatedThing - -`class ItDoesSomeObfuscatedThing` - -Check output of - -``` brainfuck -++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>. -``` - -### Constructors - -| [<init>](-init-.md) | Check output of`ItDoesSomeObfuscatedThing()` | - diff --git a/core/testdata/format/codeBlockNoHtmlEscape.kt b/core/testdata/format/codeBlockNoHtmlEscape.kt deleted file mode 100644 index 5f48b39c..00000000 --- a/core/testdata/format/codeBlockNoHtmlEscape.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Try to make this check pass - * ``` - * if(1 > 2) - * ``` - * Or just piece of html - * ``` - * <p>1 = 3</p> - * ``` - */ -fun hackTheArithmetic(){ - valueOf(1) { - set(3) - } -}
\ No newline at end of file diff --git a/core/testdata/format/codeBlockNoHtmlEscape.md b/core/testdata/format/codeBlockNoHtmlEscape.md deleted file mode 100644 index a54fc25d..00000000 --- a/core/testdata/format/codeBlockNoHtmlEscape.md +++ /dev/null @@ -1,18 +0,0 @@ -[test](../index.md) / [hackTheArithmetic](./hack-the-arithmetic.md) - -# hackTheArithmetic - -`fun hackTheArithmetic(): Unit` - -Try to make this check pass - -``` -if(1 > 2) -``` - -Or just piece of html - -``` -<p>1 = 3</p> -``` - diff --git a/core/testdata/format/codeSpan.html b/core/testdata/format/codeSpan.html deleted file mode 100644 index 28631dbf..00000000 --- a/core/testdata/format/codeSpan.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>This is a <code>code span</code>.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/codeSpan.kt b/core/testdata/format/codeSpan.kt deleted file mode 100644 index 645f454a..00000000 --- a/core/testdata/format/codeSpan.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * This is a `code span`. - */ -fun foo() {}
\ No newline at end of file diff --git a/core/testdata/format/companionImplements.kt b/core/testdata/format/companionImplements.kt deleted file mode 100644 index 154ef9b1..00000000 --- a/core/testdata/format/companionImplements.kt +++ /dev/null @@ -1,9 +0,0 @@ - -interface Bar - -/** - * Correct ref [Foo.Companion] - */ -class Foo { - companion object : Bar -}
\ No newline at end of file diff --git a/core/testdata/format/companionImplements.md b/core/testdata/format/companionImplements.md deleted file mode 100644 index 2734e1fe..00000000 --- a/core/testdata/format/companionImplements.md +++ /dev/null @@ -1,16 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo` - -Correct ref [Foo.Companion](-companion.md) - -### Types - -| [Companion](-companion.md) | `companion object Companion : `[`Bar`](../-bar.md) | - -### Constructors - -| [<init>](-init-.md) | Correct ref [Foo.Companion](-companion.md)`Foo()` | - diff --git a/core/testdata/format/companionObjectExtension.kt b/core/testdata/format/companionObjectExtension.kt deleted file mode 100644 index f452de2c..00000000 --- a/core/testdata/format/companionObjectExtension.kt +++ /dev/null @@ -1,10 +0,0 @@ -class Foo { - companion object Default { - } -} - - -/** - * The default object property. - */ -val Foo.Default.x: Int get() = 1 diff --git a/core/testdata/format/companionObjectExtension.md b/core/testdata/format/companionObjectExtension.md deleted file mode 100644 index 43dff899..00000000 --- a/core/testdata/format/companionObjectExtension.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo` - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - -### Companion Object Extension Properties - -| [x](../x.md) | The default object property.`val Foo.Default.x: Int` | - diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html deleted file mode 100644 index 4d08043c..00000000 --- a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html +++ /dev/null @@ -1,38 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Bar - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="../index.html">test</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">class </span><span class="identifier">Bar</span> <span class="symbol">:</span> <a href="../-foo/index.html"><span class="identifier">Foo</span></a></code> -<p>See <a href="../-foo/xyzzy.html">xyzzy</a></p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>See <a href="../-foo/xyzzy.html">xyzzy</a></p> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Inherited Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="../-foo/xyzzy.html">xyzzy</a></h4> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">xyzzy</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt deleted file mode 100644 index 102782f9..00000000 --- a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt +++ /dev/null @@ -1,6 +0,0 @@ -package test - -/** - * See [xyzzy] - */ -class Bar(): Foo() diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/test/Foo.java b/core/testdata/format/crossLanguage/kotlinExtendsJava/test/Foo.java deleted file mode 100644 index 7c143030..00000000 --- a/core/testdata/format/crossLanguage/kotlinExtendsJava/test/Foo.java +++ /dev/null @@ -1,6 +0,0 @@ -package test; - -public class Foo { - public void xyzzy() { - } -} diff --git a/core/testdata/format/deprecated.class.html b/core/testdata/format/deprecated.class.html deleted file mode 100644 index 11d2e944..00000000 --- a/core/testdata/format/deprecated.class.html +++ /dev/null @@ -1,59 +0,0 @@ -<!-- File: test/--root--/-c/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>C - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">C</a><br/> -<br/> -<h1>C</h1> -<code><span class="keyword">class </span><s><span class="identifier">C</span></s></code><br/> -<strong>Deprecated:</strong> This class sucks<br/> -<br/> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">C</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> -<!-- File: test/--root--/f.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f()"></a> -<code><span class="keyword">fun </span><s><span class="identifier">f</span></s><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/> -<strong>Deprecated:</strong> This function sucks<br/> -<br/> -</BODY> -</HTML> -<!-- File: test/--root--/p.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>p - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./p.html">p</a><br/> -<br/> -<h1>p</h1> -<a name="$p"></a> -<code><span class="keyword">val </span><s><span class="identifier">p</span></s><span class="symbol">: </span><span class="identifier">Int</span></code><br/> -<strong>Deprecated:</strong> This property sucks<br/> -<br/> -</BODY> -</HTML> diff --git a/core/testdata/format/deprecated.kt b/core/testdata/format/deprecated.kt deleted file mode 100644 index 4fc568c2..00000000 --- a/core/testdata/format/deprecated.kt +++ /dev/null @@ -1,5 +0,0 @@ -@Deprecated("This class sucks") class C() { } - -@Deprecated("This function sucks") fun f() { } - -@Deprecated("This property sucks") val p: Int get() = 0 diff --git a/core/testdata/format/deprecated.package.html b/core/testdata/format/deprecated.package.html deleted file mode 100644 index 5b218f74..00000000 --- a/core/testdata/format/deprecated.package.html +++ /dev/null @@ -1,47 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>root package - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a><br/> -<br/> -<h2>Package <root></h2> -<h3>Types</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-c/index.html">C</a></h4> -</td> -<td> -<code><span class="keyword">class </span><s><span class="identifier">C</span></s></code></td> -</tr> -</tbody> -</table> -<h3>Properties</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="p.html">p</a></h4> -</td> -<td> -<code><span class="keyword">val </span><s><span class="identifier">p</span></s><span class="symbol">: </span><span class="identifier">Int</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="f.html">f</a></h4> -</td> -<td> -<code><span class="keyword">fun </span><s><span class="identifier">f</span></s><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/dynamicExtension.kt b/core/testdata/format/dynamicExtension.kt deleted file mode 100644 index 5c83bf22..00000000 --- a/core/testdata/format/dynamicExtension.kt +++ /dev/null @@ -1,3 +0,0 @@ -class Foo - -fun dynamic.bar() {} diff --git a/core/testdata/format/dynamicExtension.md b/core/testdata/format/dynamicExtension.md deleted file mode 100644 index ed81d66c..00000000 --- a/core/testdata/format/dynamicExtension.md +++ /dev/null @@ -1,10 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo` - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - diff --git a/core/testdata/format/dynamicType.kt b/core/testdata/format/dynamicType.kt deleted file mode 100644 index 9d557ac0..00000000 --- a/core/testdata/format/dynamicType.kt +++ /dev/null @@ -1,2 +0,0 @@ -fun foo(): dynamic = "" - diff --git a/core/testdata/format/dynamicType.md b/core/testdata/format/dynamicType.md deleted file mode 100644 index cfb8fd25..00000000 --- a/core/testdata/format/dynamicType.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): dynamic`
\ No newline at end of file diff --git a/core/testdata/format/emptyDescription.kt b/core/testdata/format/emptyDescription.kt deleted file mode 100644 index 3ed81dfa..00000000 --- a/core/testdata/format/emptyDescription.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Function fn - */ -fun fn() { -}
\ No newline at end of file diff --git a/core/testdata/format/emptyDescription.md b/core/testdata/format/emptyDescription.md deleted file mode 100644 index 3c14ab75..00000000 --- a/core/testdata/format/emptyDescription.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [fn](./fn.md) - -# fn - -`fun fn(): Unit` - -Function fn - diff --git a/core/testdata/format/entity.html b/core/testdata/format/entity.html deleted file mode 100644 index bfeb34ea..00000000 --- a/core/testdata/format/entity.html +++ /dev/null @@ -1,26 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Bar - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">class </span><span class="identifier">Bar</span></code> -<p>Copyright © JetBrains 2015 "</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Copyright © JetBrains 2015 "</p> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/entity.kt b/core/testdata/format/entity.kt deleted file mode 100644 index 163d2ee6..00000000 --- a/core/testdata/format/entity.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Copyright © JetBrains 2015 " - */ -class Bar {} diff --git a/core/testdata/format/enumClass.kt b/core/testdata/format/enumClass.kt deleted file mode 100644 index 3c2a49fc..00000000 --- a/core/testdata/format/enumClass.kt +++ /dev/null @@ -1,4 +0,0 @@ -public enum class InlineOption { - ONLY_LOCAL_RETURN, - LOCAL_CONTINUE_AND_BREAK -} diff --git a/core/testdata/format/enumClass.md b/core/testdata/format/enumClass.md deleted file mode 100644 index 15070049..00000000 --- a/core/testdata/format/enumClass.md +++ /dev/null @@ -1,11 +0,0 @@ -[test](../../index.md) / [InlineOption](./index.md) - -# InlineOption - -`enum class InlineOption` - -### Enum Values - -| [ONLY_LOCAL_RETURN](-o-n-l-y_-l-o-c-a-l_-r-e-t-u-r-n.md) | | -| [LOCAL_CONTINUE_AND_BREAK](-l-o-c-a-l_-c-o-n-t-i-n-u-e_-a-n-d_-b-r-e-a-k.md) | | - diff --git a/core/testdata/format/enumClass.value.md b/core/testdata/format/enumClass.value.md deleted file mode 100644 index 9000a1c4..00000000 --- a/core/testdata/format/enumClass.value.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../../index.md) / [InlineOption](index.md) / [LOCAL_CONTINUE_AND_BREAK](./-l-o-c-a-l_-c-o-n-t-i-n-u-e_-a-n-d_-b-r-e-a-k.md) - -# LOCAL_CONTINUE_AND_BREAK - -`LOCAL_CONTINUE_AND_BREAK`
\ No newline at end of file diff --git a/core/testdata/format/enumRef.kt b/core/testdata/format/enumRef.kt deleted file mode 100644 index 5c0b2de9..00000000 --- a/core/testdata/format/enumRef.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * [java.math.RoundingMode.UP] - */ -fun f() {}
\ No newline at end of file diff --git a/core/testdata/format/enumRef.md b/core/testdata/format/enumRef.md deleted file mode 100644 index 5f6b2f64..00000000 --- a/core/testdata/format/enumRef.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`fun f(): Unit` - -[java.math.RoundingMode.UP](https://docs.oracle.com/javase/6/docs/api/java/math/RoundingMode.html#UP) - diff --git a/core/testdata/format/exceptionClass.kt b/core/testdata/format/exceptionClass.kt deleted file mode 100644 index d005bd89..00000000 --- a/core/testdata/format/exceptionClass.kt +++ /dev/null @@ -1 +0,0 @@ -class MyException : Exception diff --git a/core/testdata/format/exceptionClass.md b/core/testdata/format/exceptionClass.md deleted file mode 100644 index 44ad6705..00000000 --- a/core/testdata/format/exceptionClass.md +++ /dev/null @@ -1,10 +0,0 @@ -[test](../../index.md) / [MyException](./index.md) - -# MyException - -`class MyException : Exception` - -### Constructors - -| [<init>](-init-.md) | `MyException()` | - diff --git a/core/testdata/format/exceptionClass.package.md b/core/testdata/format/exceptionClass.package.md deleted file mode 100644 index 13b1c7db..00000000 --- a/core/testdata/format/exceptionClass.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Exceptions - -| [MyException](-my-exception/index.md) | `class MyException : Exception` | - diff --git a/core/testdata/format/exclInCodeBlock.kt b/core/testdata/format/exclInCodeBlock.kt deleted file mode 100644 index 62b234dd..00000000 --- a/core/testdata/format/exclInCodeBlock.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * The magic word is `!` - */ -fun foo() { -} diff --git a/core/testdata/format/exclInCodeBlock.md b/core/testdata/format/exclInCodeBlock.md deleted file mode 100644 index 0302570e..00000000 --- a/core/testdata/format/exclInCodeBlock.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): Unit` - -The magic word is `!` - diff --git a/core/testdata/format/extensionFunctionParameter.kt b/core/testdata/format/extensionFunctionParameter.kt deleted file mode 100644 index bfb344b9..00000000 --- a/core/testdata/format/extensionFunctionParameter.kt +++ /dev/null @@ -1 +0,0 @@ -public inline fun <T> T.apply(f: T.() -> Unit): T { f(); return this } diff --git a/core/testdata/format/extensionFunctionParameter.md b/core/testdata/format/extensionFunctionParameter.md deleted file mode 100644 index 465fe358..00000000 --- a/core/testdata/format/extensionFunctionParameter.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [apply](./apply.md) - -# apply - -`inline fun <T> `[`T`](apply.md#T)`.apply(f: `[`T`](apply.md#T)`.() -> Unit): `[`T`](apply.md#T)
\ No newline at end of file diff --git a/core/testdata/format/extensionScope.kt b/core/testdata/format/extensionScope.kt deleted file mode 100644 index 9f3130b8..00000000 --- a/core/testdata/format/extensionScope.kt +++ /dev/null @@ -1,14 +0,0 @@ -/** - * Test class with Type-parameter - */ -class Foo<T> - -/** - * Some extension on Foo - */ -fun <T> Foo<T>.ext() {} - -/** - * Correct link: [Foo.ext] - */ -fun test() {}
\ No newline at end of file diff --git a/core/testdata/format/extensionScope.md b/core/testdata/format/extensionScope.md deleted file mode 100644 index 2921346a..00000000 --- a/core/testdata/format/extensionScope.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [test](./test.md) - -# test - -`fun test(): Unit` - -Correct link: [Foo.ext](ext.md) - diff --git a/core/testdata/format/extensionWithDocumentedReceiver.kt b/core/testdata/format/extensionWithDocumentedReceiver.kt deleted file mode 100644 index 37fc09d9..00000000 --- a/core/testdata/format/extensionWithDocumentedReceiver.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Function with receiver - * @receiver must be a non-empty string - */ -fun String.fn() { -} diff --git a/core/testdata/format/extensionWithDocumentedReceiver.md b/core/testdata/format/extensionWithDocumentedReceiver.md deleted file mode 100644 index 4cee0a04..00000000 --- a/core/testdata/format/extensionWithDocumentedReceiver.md +++ /dev/null @@ -1,11 +0,0 @@ -[test](../../index.md) / [kotlin.String](index.md) / [fn](./fn.md) - -# fn - -`fun String.fn(): Unit` - -Function with receiver - -**Receiver** -must be a non-empty string - diff --git a/core/testdata/format/extensions.class.md b/core/testdata/format/extensions.class.md deleted file mode 100644 index cd1bb70e..00000000 --- a/core/testdata/format/extensions.class.md +++ /dev/null @@ -1,7 +0,0 @@ -[test](../../index.md) / [foo](../index.md) / [kotlin.String](./index.md) - -### Extensions for kotlin.String - -| [fn](fn.md) | Function with receiver`fun String.fn(): Unit`<br>`fun String.fn(x: Int): Unit` | -| [foobar](foobar.md) | Property with receiver.`val String.foobar: Int` | - diff --git a/core/testdata/format/extensions.kt b/core/testdata/format/extensions.kt deleted file mode 100644 index 6f2eff9d..00000000 --- a/core/testdata/format/extensions.kt +++ /dev/null @@ -1,19 +0,0 @@ -package foo - -/** - * Function with receiver - */ -fun String.fn() { -} - -/** - * Function with receiver - */ -fun String.fn(x: Int) { -} - -/** - * Property with receiver. - */ -val String.foobar: Int - get() = size() * 2 diff --git a/core/testdata/format/extensions.package.md b/core/testdata/format/extensions.package.md deleted file mode 100644 index ad895116..00000000 --- a/core/testdata/format/extensions.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./index.md) - -## Package foo - -### Extensions for External Classes - -| [kotlin.String](kotlin.-string/index.md) | | - diff --git a/core/testdata/format/externalReferenceLink.kt b/core/testdata/format/externalReferenceLink.kt deleted file mode 100644 index 775b2e66..00000000 --- a/core/testdata/format/externalReferenceLink.kt +++ /dev/null @@ -1,10 +0,0 @@ -/** - * It is link to [example site][example.com] - * - * Sure, it is [example.com] - * - * [example.com]: https://example.com - */ -fun a() { - -}
\ No newline at end of file diff --git a/core/testdata/format/externalReferenceLink.md b/core/testdata/format/externalReferenceLink.md deleted file mode 100644 index 73840e76..00000000 --- a/core/testdata/format/externalReferenceLink.md +++ /dev/null @@ -1,10 +0,0 @@ -[test](../index.md) / [a](./a.md) - -# a - -`fun a(): Unit` - -It is link to [example site](https://example.com) - -Sure, it is [example.com](https://example.com) - diff --git a/core/testdata/format/functionWithDefaultParameter.kt b/core/testdata/format/functionWithDefaultParameter.kt deleted file mode 100644 index 3a3a102f..00000000 --- a/core/testdata/format/functionWithDefaultParameter.kt +++ /dev/null @@ -1 +0,0 @@ -fun f(x: String = "") {} diff --git a/core/testdata/format/functionWithDefaultParameter.md b/core/testdata/format/functionWithDefaultParameter.md deleted file mode 100644 index 535ea18d..00000000 --- a/core/testdata/format/functionWithDefaultParameter.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`fun f(x: String = ""): Unit`
\ No newline at end of file diff --git a/core/testdata/format/functionalTypeWithNamedParameters.html b/core/testdata/format/functionalTypeWithNamedParameters.html deleted file mode 100644 index af97eb4e..00000000 --- a/core/testdata/format/functionalTypeWithNamedParameters.html +++ /dev/null @@ -1,103 +0,0 @@ -<!-- File: test/--root--/-a/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>A - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">A</a><br/> -<br/> -<h1>A</h1> -<code><span class="keyword">class </span><span class="identifier">A</span></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">A</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> -<!-- File: test/--root--/-b/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>B - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">B</a><br/> -<br/> -<h1>B</h1> -<code><span class="keyword">class </span><span class="identifier">B</span></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">B</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> -<!-- File: test/--root--/-c/index.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>C - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">C</a><br/> -<br/> -<h1>C</h1> -<code><span class="keyword">class </span><span class="identifier">C</span></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">C</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> -<!-- File: test/--root--/f.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f"></a> -<code><span class="keyword">val </span><span class="identifier">f</span><span class="symbol">: </span><span class="symbol">(</span><span class="identifier">a</span><span class="symbol">:</span> <a href="-a/index.html"><span class="identifier">A</span></a><span class="symbol">,</span> <span class="identifier">b</span><span class="symbol">:</span> <a href="-b/index.html"><span class="identifier">B</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="-c/index.html"><span class="identifier">C</span></a></code> -</BODY> -</HTML> -<!-- File: test/--root--/accept-function-type-with-named-arguments.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>acceptFunctionTypeWithNamedArguments - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./accept-function-type-with-named-arguments.html">acceptFunctionTypeWithNamedArguments</a><br/> -<br/> -<h1>acceptFunctionTypeWithNamedArguments</h1> -<a name="$acceptFunctionTypeWithNamedArguments(kotlin.Function2((B, A, C)))"></a> -<code><span class="keyword">fun </span><span class="identifier">acceptFunctionTypeWithNamedArguments</span><span class="symbol">(</span><span class="identifier" id="$acceptFunctionTypeWithNamedArguments(kotlin.Function2((B, A, C)))/f">f</span><span class="symbol">:</span> <span class="symbol">(</span><span class="identifier">bb</span><span class="symbol">:</span> <a href="-b/index.html"><span class="identifier">B</span></a><span class="symbol">,</span> <span class="identifier">aa</span><span class="symbol">:</span> <a href="-a/index.html"><span class="identifier">A</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="-c/index.html"><span class="identifier">C</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -</BODY> -</HTML> diff --git a/core/testdata/format/functionalTypeWithNamedParameters.kt b/core/testdata/format/functionalTypeWithNamedParameters.kt deleted file mode 100644 index 3dada27a..00000000 --- a/core/testdata/format/functionalTypeWithNamedParameters.kt +++ /dev/null @@ -1,9 +0,0 @@ -class A -class B -class C - -val f: (a: A, b: B) -> C = { a, b -> C() } - -fun acceptFunctionTypeWithNamedArguments(f: (bb: B, aa: A) -> C) { - -}
\ No newline at end of file diff --git a/core/testdata/format/functionalTypeWithNamedParameters.md b/core/testdata/format/functionalTypeWithNamedParameters.md deleted file mode 100644 index e1c9681a..00000000 --- a/core/testdata/format/functionalTypeWithNamedParameters.md +++ /dev/null @@ -1,45 +0,0 @@ -<!-- File: test/--root--/-a/index.md --> -[test](../../index.md) / [A](./index.md) - -# A - -`class A` - -### Constructors - -| [<init>](-init-.md) | `A()` | - -<!-- File: test/--root--/-b/index.md --> -[test](../../index.md) / [B](./index.md) - -# B - -`class B` - -### Constructors - -| [<init>](-init-.md) | `B()` | - -<!-- File: test/--root--/-c/index.md --> -[test](../../index.md) / [C](./index.md) - -# C - -`class C` - -### Constructors - -| [<init>](-init-.md) | `C()` | - -<!-- File: test/--root--/f.md --> -[test](../index.md) / [f](./f.md) - -# f - -`val f: (a: `[`A`](-a/index.md)`, b: `[`B`](-b/index.md)`) -> `[`C`](-c/index.md) -<!-- File: test/--root--/accept-function-type-with-named-arguments.md --> -[test](../index.md) / [acceptFunctionTypeWithNamedArguments](./accept-function-type-with-named-arguments.md) - -# acceptFunctionTypeWithNamedArguments - -`fun acceptFunctionTypeWithNamedArguments(f: (bb: `[`B`](-b/index.md)`, aa: `[`A`](-a/index.md)`) -> `[`C`](-c/index.md)`): Unit`
\ No newline at end of file diff --git a/core/testdata/format/genericInheritedExtensions.kt b/core/testdata/format/genericInheritedExtensions.kt deleted file mode 100644 index 4c07e1e5..00000000 --- a/core/testdata/format/genericInheritedExtensions.kt +++ /dev/null @@ -1,11 +0,0 @@ -open class Foo<T> - -class Bar<T> : Foo<T>() - -fun <T> Foo<T>.first() { - -} - -fun <T> Bar<T>.second() { - -} diff --git a/core/testdata/format/genericInheritedExtensions.md b/core/testdata/format/genericInheritedExtensions.md deleted file mode 100644 index 90397676..00000000 --- a/core/testdata/format/genericInheritedExtensions.md +++ /dev/null @@ -1,15 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar<T> : `[`Foo`](../-foo/index.md)`<`[`T`](index.md#T)`>` - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Extension Functions - -| [first](../first.md) | `fun <T> `[`Foo`](../-foo/index.md)`<`[`T`](../first.md#T)`>.first(): Unit` | -| [second](../second.md) | `fun <T> `[`Bar`](./index.md)`<`[`T`](../second.md#T)`>.second(): Unit` | - diff --git a/core/testdata/format/gfm/listInTableCell.kt b/core/testdata/format/gfm/listInTableCell.kt deleted file mode 100644 index 2f4fdf54..00000000 --- a/core/testdata/format/gfm/listInTableCell.kt +++ /dev/null @@ -1,8 +0,0 @@ -class Foo { - /** - * 1. Foo - * 1. Bar - */ - fun foo() { - } -} diff --git a/core/testdata/format/gfm/listInTableCell.md b/core/testdata/format/gfm/listInTableCell.md deleted file mode 100644 index 1cafb61a..00000000 --- a/core/testdata/format/gfm/listInTableCell.md +++ /dev/null @@ -1,17 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo` - -### Constructors - -| Name | Summary | -|---|---| -| [<init>](-init-.md) | `Foo()` | - -### Functions - -| Name | Summary | -|---|---| -| [foo](foo.md) | <ol><li>Foo</li><li>Bar</li></ol>`fun foo(): Unit` | diff --git a/core/testdata/format/gfm/sample.kt b/core/testdata/format/gfm/sample.kt deleted file mode 100644 index 3300d2c8..00000000 --- a/core/testdata/format/gfm/sample.kt +++ /dev/null @@ -1,18 +0,0 @@ -/** - * The class Foo. - */ -class Foo { - /** - * The method bar. - */ - fun bar() { - - } - - /** - * The method baz. - */ - fun baz() { - - } -}
\ No newline at end of file diff --git a/core/testdata/format/gfm/sample.md b/core/testdata/format/gfm/sample.md deleted file mode 100644 index a9464ea3..00000000 --- a/core/testdata/format/gfm/sample.md +++ /dev/null @@ -1,20 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo` - -The class Foo. - -### Constructors - -| Name | Summary | -|---|---| -| [<init>](-init-.md) | The class Foo.`Foo()` | - -### Functions - -| Name | Summary | -|---|---| -| [bar](bar.md) | The method bar.`fun bar(): Unit` | -| [baz](baz.md) | The method baz.`fun baz(): Unit` | diff --git a/core/testdata/format/htmlEscaping.html b/core/testdata/format/htmlEscaping.html deleted file mode 100644 index 435c3149..00000000 --- a/core/testdata/format/htmlEscaping.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>x - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./x.html">x</a><br/> -<br/> -<h1>x</h1> -<a name="$x()"></a> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">x</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="x.html#T"><span class="identifier">T</span></a><span class="symbol">?</span></code> -<p>Special characters: < is "less than", > is "greater than", & is "ampersand"</p> -</BODY> -</HTML> diff --git a/core/testdata/format/htmlEscaping.kt b/core/testdata/format/htmlEscaping.kt deleted file mode 100644 index 8778d8a5..00000000 --- a/core/testdata/format/htmlEscaping.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Special characters: < is "less than", > is "greater than", & is "ampersand" - */ -fun x<T>(): T? = null diff --git a/core/testdata/format/inapplicableExtensionFunctions.kt b/core/testdata/format/inapplicableExtensionFunctions.kt deleted file mode 100644 index d2c65b46..00000000 --- a/core/testdata/format/inapplicableExtensionFunctions.kt +++ /dev/null @@ -1,11 +0,0 @@ -open class Foo<T> { -} - -class Bar : Foo<Char>() { -} - -fun Foo<Int>.shazam() { -} - -fun Bar.xyzzy() { -} diff --git a/core/testdata/format/inapplicableExtensionFunctions.md b/core/testdata/format/inapplicableExtensionFunctions.md deleted file mode 100644 index 35124b3d..00000000 --- a/core/testdata/format/inapplicableExtensionFunctions.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar : `[`Foo`](../-foo/index.md)`<Char>` - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Extension Functions - -| [xyzzy](../xyzzy.md) | `fun `[`Bar`](./index.md)`.xyzzy(): Unit` | - diff --git a/core/testdata/format/indentedCodeBlock.html b/core/testdata/format/indentedCodeBlock.html deleted file mode 100644 index 5b4677d1..00000000 --- a/core/testdata/format/indentedCodeBlock.html +++ /dev/null @@ -1,17 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>Create a new Foo value as follows:</p> -<pre><code> val foo = Foo.create { - type { "ABC" } - }</code></pre> -</BODY> -</HTML> diff --git a/core/testdata/format/indentedCodeBlock.kt b/core/testdata/format/indentedCodeBlock.kt deleted file mode 100644 index 19c5365b..00000000 --- a/core/testdata/format/indentedCodeBlock.kt +++ /dev/null @@ -1,10 +0,0 @@ -/** - * Create a new Foo value as follows: - * - * val foo = Foo.create { - * type { "ABC" } - * } - */ -fun foo() { - -}
\ No newline at end of file diff --git a/core/testdata/format/indentedCodeBlock.md b/core/testdata/format/indentedCodeBlock.md deleted file mode 100644 index 7542ddb9..00000000 --- a/core/testdata/format/indentedCodeBlock.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): Unit` - -Create a new Foo value as follows: - -``` - val foo = Foo.create { - type { "ABC" } - } -``` - diff --git a/core/testdata/format/inheritedCompanionObjectProperties.kt b/core/testdata/format/inheritedCompanionObjectProperties.kt deleted file mode 100644 index 74a3749c..00000000 --- a/core/testdata/format/inheritedCompanionObjectProperties.kt +++ /dev/null @@ -1,18 +0,0 @@ -open class A { - fun foo() { - } -} - -open class B { - fun bar() { - } -} - -class C : A { - fun xyzzy() { - } - - companion object : B () { - fun shazam() - } -} diff --git a/core/testdata/format/inheritedCompanionObjectProperties.md b/core/testdata/format/inheritedCompanionObjectProperties.md deleted file mode 100644 index 700570cc..00000000 --- a/core/testdata/format/inheritedCompanionObjectProperties.md +++ /dev/null @@ -1,30 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`class C : `[`A`](../-a/index.md) - -### Types - -| [Companion](-companion/index.md) | `companion object Companion : `[`B`](../-b/index.md) | - -### Constructors - -| [<init>](-init-.md) | `C()` | - -### Functions - -| [xyzzy](xyzzy.md) | `fun xyzzy(): Unit` | - -### Inherited Functions - -| [foo](../-a/foo.md) | `fun foo(): Unit` | - -### Companion Object Functions - -| [shazam](shazam.md) | `fun shazam(): Unit` | - -### Inherited Companion Object Functions - -| [bar](../-b/bar.md) | `fun bar(): Unit` | - diff --git a/core/testdata/format/inheritedExtensions.kt b/core/testdata/format/inheritedExtensions.kt deleted file mode 100644 index e38fe00d..00000000 --- a/core/testdata/format/inheritedExtensions.kt +++ /dev/null @@ -1,11 +0,0 @@ -open class Foo - -class Bar : Foo() - -fun Foo.first() { - -} - -fun Bar.second() { - -} diff --git a/core/testdata/format/inheritedExtensions.md b/core/testdata/format/inheritedExtensions.md deleted file mode 100644 index 3b105e28..00000000 --- a/core/testdata/format/inheritedExtensions.md +++ /dev/null @@ -1,15 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar : `[`Foo`](../-foo/index.md) - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Extension Functions - -| [first](../first.md) | `fun `[`Foo`](../-foo/index.md)`.first(): Unit` | -| [second](../second.md) | `fun `[`Bar`](./index.md)`.second(): Unit` | - diff --git a/core/testdata/format/inheritedLink.1.kt b/core/testdata/format/inheritedLink.1.kt deleted file mode 100644 index 29cc12b4..00000000 --- a/core/testdata/format/inheritedLink.1.kt +++ /dev/null @@ -1,10 +0,0 @@ -package p1 - -import java.util.LinkedList - -interface Foo { - - /** Says hello - [LinkedList]. */ - fun sayHello() : String - -}
\ No newline at end of file diff --git a/core/testdata/format/inheritedLink.kt b/core/testdata/format/inheritedLink.kt deleted file mode 100644 index 86b8f4e2..00000000 --- a/core/testdata/format/inheritedLink.kt +++ /dev/null @@ -1,11 +0,0 @@ -package p2 - -import p1.Foo - -class FooBar : Foo { - - override fun sayHello(): String { - return "Hello!" - } - -}
\ No newline at end of file diff --git a/core/testdata/format/inheritedLink.md b/core/testdata/format/inheritedLink.md deleted file mode 100644 index aec07a75..00000000 --- a/core/testdata/format/inheritedLink.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- File: test/p2/-foo-bar/-init-.md --> -[test](../../index.md) / [p2](../index.md) / [FooBar](index.md) / [<init>](./-init-.md) - -# <init> - -`FooBar()` -<!-- File: test/p2/-foo-bar/say-hello.md --> -[test](../../index.md) / [p2](../index.md) / [FooBar](index.md) / [sayHello](./say-hello.md) - -# sayHello - -`fun sayHello(): String` - -Overrides [Foo.sayHello](../../p1/-foo/say-hello.md) - -Says hello - [LinkedList](https://docs.oracle.com/javase/6/docs/api/java/util/LinkedList.html). - diff --git a/core/testdata/format/inheritedMembers.kt b/core/testdata/format/inheritedMembers.kt deleted file mode 100644 index 2d0c4ca1..00000000 --- a/core/testdata/format/inheritedMembers.kt +++ /dev/null @@ -1,12 +0,0 @@ -open class Foo { - fun first() { - } - - val firstProp: Int = 0 -} - -class Bar : Foo() { - fun second() - - val secondProp: Int = 1 -} diff --git a/core/testdata/format/inheritedMembers.md b/core/testdata/format/inheritedMembers.md deleted file mode 100644 index 0bf1a5f6..00000000 --- a/core/testdata/format/inheritedMembers.md +++ /dev/null @@ -1,26 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar : `[`Foo`](../-foo/index.md) - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Properties - -| [secondProp](second-prop.md) | `val secondProp: Int` | - -### Inherited Properties - -| [firstProp](../-foo/first-prop.md) | `val firstProp: Int` | - -### Functions - -| [second](second.md) | `fun second(): Unit` | - -### Inherited Functions - -| [first](../-foo/first.md) | `fun first(): Unit` | - diff --git a/core/testdata/format/inlineSuspendFunction.kt b/core/testdata/format/inlineSuspendFunction.kt deleted file mode 100644 index 02b3094b..00000000 --- a/core/testdata/format/inlineSuspendFunction.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * returns 1 - */ -inline suspend fun foo(a: () -> String): Int { - 1 -} diff --git a/core/testdata/format/inlineSuspendFunction.md b/core/testdata/format/inlineSuspendFunction.md deleted file mode 100644 index e109039c..00000000 --- a/core/testdata/format/inlineSuspendFunction.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`suspend inline fun foo(a: () -> String): Int` - -returns 1 - diff --git a/core/testdata/format/javaCodeInParam.java b/core/testdata/format/javaCodeInParam.java deleted file mode 100644 index 0d1607ba..00000000 --- a/core/testdata/format/javaCodeInParam.java +++ /dev/null @@ -1,7 +0,0 @@ -class C { - - /** - * @param par this is {@code some code} and other text - */ - public void withParam(String par) {} -} diff --git a/core/testdata/format/javaCodeInParam.md b/core/testdata/format/javaCodeInParam.md deleted file mode 100644 index 7bdf4f62..00000000 --- a/core/testdata/format/javaCodeInParam.md +++ /dev/null @@ -1,9 +0,0 @@ -[test](../../index.md) / [C](index.md) / [withParam](./with-param.md) - -# withParam - -`open fun withParam(par: String!): Unit` - -### Parameters - -`par` - String!: this is `some code` and other text
\ No newline at end of file diff --git a/core/testdata/format/javaCodeLiteralTags.java b/core/testdata/format/javaCodeLiteralTags.java deleted file mode 100644 index e71ddaa7..00000000 --- a/core/testdata/format/javaCodeLiteralTags.java +++ /dev/null @@ -1,6 +0,0 @@ -/** - * <p>{@code A<B>C}</p> - * <p>{@literal A<B>C}</p> - */ -class C { -} diff --git a/core/testdata/format/javaCodeLiteralTags.md b/core/testdata/format/javaCodeLiteralTags.md deleted file mode 100644 index 88472b87..00000000 --- a/core/testdata/format/javaCodeLiteralTags.md +++ /dev/null @@ -1,16 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`protected open class C` - -`A<B>C` - - - -A<B>C - -### Constructors - -| [<init>](-init-.md) | `A<B>C``C()` | - diff --git a/core/testdata/format/javaDeprecated.html b/core/testdata/format/javaDeprecated.html deleted file mode 100644 index 66e3adef..00000000 --- a/core/testdata/format/javaDeprecated.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Foo.foo - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="index.html">Foo</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="Foo$foo()"></a> -<code><span class="keyword">open</span> <span class="keyword">fun </span><s><span class="identifier">foo</span></s><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/> -<strong>Deprecated:</strong> use <code><a href="bar.html">#bar</a></code> instead -</BODY> -</HTML> diff --git a/core/testdata/format/javaDeprecated.java b/core/testdata/format/javaDeprecated.java deleted file mode 100644 index 9694a444..00000000 --- a/core/testdata/format/javaDeprecated.java +++ /dev/null @@ -1,5 +0,0 @@ -class Foo { - /** @deprecated use {@link #bar} instead */ - public void foo() {} - public void bar() {} -} diff --git a/core/testdata/format/javaLinkTag.html b/core/testdata/format/javaLinkTag.html deleted file mode 100644 index f61673d5..00000000 --- a/core/testdata/format/javaLinkTag.html +++ /dev/null @@ -1,38 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Foo - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Foo</a><br/> -<br/> -<h1>Foo</h1> -<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Foo</span></code> -<p>Call <code><a href="bar.html">#bar()</a></code> to do the job.</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Call <code><a href="bar.html">#bar()</a></code> to do the job.</p> -<code><span class="identifier">Foo</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="bar.html">bar</a></h4> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">bar</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/javaLinkTag.java b/core/testdata/format/javaLinkTag.java deleted file mode 100644 index 84f761c6..00000000 --- a/core/testdata/format/javaLinkTag.java +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Call {@link #bar()} to do the job. - */ -class Foo { - public void bar() -} diff --git a/core/testdata/format/javaLinkTagWithLabel.html b/core/testdata/format/javaLinkTagWithLabel.html deleted file mode 100644 index 92c67795..00000000 --- a/core/testdata/format/javaLinkTagWithLabel.html +++ /dev/null @@ -1,38 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Foo - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Foo</a><br/> -<br/> -<h1>Foo</h1> -<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Foo</span></code> -<p>Call <code><a href="bar.html">this wonderful method</a></code> to do the job.</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Call <code><a href="bar.html">this wonderful method</a></code> to do the job.</p> -<code><span class="identifier">Foo</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="bar.html">bar</a></h4> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">bar</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/javaLinkTagWithLabel.java b/core/testdata/format/javaLinkTagWithLabel.java deleted file mode 100644 index 1db5ad70..00000000 --- a/core/testdata/format/javaLinkTagWithLabel.java +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Call {@link #bar() this wonderful method} to do the job. - */ -class Foo { - public void bar() -} diff --git a/core/testdata/format/javaSeeTag.html b/core/testdata/format/javaSeeTag.html deleted file mode 100644 index dd19c56c..00000000 --- a/core/testdata/format/javaSeeTag.html +++ /dev/null @@ -1,38 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Foo - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Foo</a><br/> -<br/> -<h1>Foo</h1> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Foo</span></code> -<p><strong>See Also</strong><br/> -<a href="bar.html">#bar</a></p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">Foo</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="bar.html">bar</a></h4> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">bar</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/javaSeeTag.java b/core/testdata/format/javaSeeTag.java deleted file mode 100644 index 94a24606..00000000 --- a/core/testdata/format/javaSeeTag.java +++ /dev/null @@ -1,6 +0,0 @@ -/** - * @see #bar - */ -public class Foo { - public void bar() {} -}
\ No newline at end of file diff --git a/core/testdata/format/javaSpaceInAuthor.java b/core/testdata/format/javaSpaceInAuthor.java deleted file mode 100644 index f980ae07..00000000 --- a/core/testdata/format/javaSpaceInAuthor.java +++ /dev/null @@ -1,5 +0,0 @@ -/** - * @author Dmitry Jemerov - */ -class C { -}
\ No newline at end of file diff --git a/core/testdata/format/javaSpaceInAuthor.md b/core/testdata/format/javaSpaceInAuthor.md deleted file mode 100644 index fc6c53f8..00000000 --- a/core/testdata/format/javaSpaceInAuthor.md +++ /dev/null @@ -1,13 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`protected open class C` - -**Author** -Dmitry Jemerov - -### Constructors - -| [<init>](-init-.md) | `C()` | - diff --git a/core/testdata/format/javadocHtml.java b/core/testdata/format/javadocHtml.java deleted file mode 100644 index 9e77402e..00000000 --- a/core/testdata/format/javadocHtml.java +++ /dev/null @@ -1,26 +0,0 @@ -/** - * <b>Bold</b> - * <strong>Strong</strong> - * <i>Italic</i> - * <em>Emphasized</em> - * <p>Paragraph</p> - * <s>Strikethrough</s> - * <del>Deleted</del> - * <code>Code</code> - * <pre>Block code</pre> - * <ul><li>List Item</li></ul> - * <pre> - * with( some ) { - * multi = lines - * sample() - * } - * </pre> - * <pre> - * {@code - * with (some) { <code> } - * } - * </pre> - * - */ -public class C { -} diff --git a/core/testdata/format/javadocHtml.md b/core/testdata/format/javadocHtml.md deleted file mode 100644 index b6a03cd6..00000000 --- a/core/testdata/format/javadocHtml.md +++ /dev/null @@ -1,38 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`open class C` - -**Bold** **Strong** *Italic* *Emphasized* - -Paragraph - - ~~Strikethrough~~ ~~Deleted~~ `Code` - -``` -Block code -``` - - * List Item - - -``` - - with( some ) { - multi = lines - sample() - } - ``` - - - -``` -with (some) { <code> } - - ``` - -### Constructors - -| [<init>](-init-.md) | **Bold** **Strong** *Italic* *Emphasized* `C()` | - diff --git a/core/testdata/format/javadocOrderedList.java b/core/testdata/format/javadocOrderedList.java deleted file mode 100644 index c32d9032..00000000 --- a/core/testdata/format/javadocOrderedList.java +++ /dev/null @@ -1,8 +0,0 @@ -/** - * <ol> - * <li>Rinse</li> - * <li>Repeat</li> - * </ol> - */ -public class Bar { -} diff --git a/core/testdata/format/javadocOrderedList.md b/core/testdata/format/javadocOrderedList.md deleted file mode 100644 index 1d94ad5b..00000000 --- a/core/testdata/format/javadocOrderedList.md +++ /dev/null @@ -1,17 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`open class Bar` - - 1. Rinse - 2. Repeat - - -### Constructors - -| [<init>](-init-.md) | -1. Rinse - 2. Repeat - <br>`Bar()` | - diff --git a/core/testdata/format/jdkLinks.kt b/core/testdata/format/jdkLinks.kt deleted file mode 100644 index 660fb4ce..00000000 --- a/core/testdata/format/jdkLinks.kt +++ /dev/null @@ -1,7 +0,0 @@ -/** - * This is a [ClassLoader] and I can get its [ClassLoader.getResource] - * - * You can print something to [java.lang.System.out] now! - */ -class C : ClassLoader { -} diff --git a/core/testdata/format/jdkLinks.md b/core/testdata/format/jdkLinks.md deleted file mode 100644 index eddee485..00000000 --- a/core/testdata/format/jdkLinks.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`class C : `[`ClassLoader`](https://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html) - -This is a [ClassLoader](https://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html) and I can get its [ClassLoader.getResource](https://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String)) - -You can print something to [java.lang.System.out](https://docs.oracle.com/javase/6/docs/api/java/lang/System.html#out) now! - -### Constructors - -| [<init>](-init-.md) | This is a [ClassLoader](https://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html) and I can get its [ClassLoader.getResource](https://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String))`C()` | - diff --git a/core/testdata/format/linkWithLabel.html b/core/testdata/format/linkWithLabel.html deleted file mode 100644 index 52dfa4a3..00000000 --- a/core/testdata/format/linkWithLabel.html +++ /dev/null @@ -1,38 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Bar - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">class </span><span class="identifier">Bar</span></code> -<p>Use <a href="foo.html">this method</a> for best results.</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Use <a href="foo.html">this method</a> for best results.</p> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="foo.html">foo</a></h4> -</td> -<td> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/linkWithLabel.kt b/core/testdata/format/linkWithLabel.kt deleted file mode 100644 index 4a85c505..00000000 --- a/core/testdata/format/linkWithLabel.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Use [this method][Bar.foo] for best results. - */ -class Bar { - fun foo() {} -} diff --git a/core/testdata/format/linkWithStarProjection.html b/core/testdata/format/linkWithStarProjection.html deleted file mode 100644 index ce9b82c6..00000000 --- a/core/testdata/format/linkWithStarProjection.html +++ /dev/null @@ -1,24 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>KClassLoader - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">KClassLoader</a><br/> -<br/> -<h1>KClassLoader</h1> -<code><span class="keyword">object </span><span class="identifier">KClassLoader</span></code> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="foo.html">foo</a></h4> -</td> -<td> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="identifier" id="KClassLoader$foo(kotlin.Enum(()))/c">c</span><span class="symbol">:</span> <span class="identifier">Enum</span><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/linkWithStarProjection.kt b/core/testdata/format/linkWithStarProjection.kt deleted file mode 100644 index 6da6c595..00000000 --- a/core/testdata/format/linkWithStarProjection.kt +++ /dev/null @@ -1,3 +0,0 @@ -object KClassLoader { - fun foo(c: Enum<*>) { } -} diff --git a/core/testdata/format/linksInEmphasis.kt b/core/testdata/format/linksInEmphasis.kt deleted file mode 100644 index 3e2017d2..00000000 --- a/core/testdata/format/linksInEmphasis.kt +++ /dev/null @@ -1,13 +0,0 @@ -/** - * An emphasised class. - * - * _This class [Bar] is awesome._ - * - * _Even more awesomer is the function [Bar.foo]_ - * - * _[Bar.hello] is also OK_ - */ -class Bar { - fun foo() {} - fun hello() {} -} diff --git a/core/testdata/format/linksInEmphasis.md b/core/testdata/format/linksInEmphasis.md deleted file mode 100644 index 984941fa..00000000 --- a/core/testdata/format/linksInEmphasis.md +++ /dev/null @@ -1,23 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -An emphasised class. - -*This class [Bar](./index.md) is awesome.* - -*Even more awesomer is the function [Bar.foo](foo.md)* - -*[Bar.hello](hello.md) is also OK* - -### Constructors - -| [<init>](-init-.md) | An emphasised class.`Bar()` | - -### Functions - -| [foo](foo.md) | `fun foo(): Unit` | -| [hello](hello.md) | `fun hello(): Unit` | - diff --git a/core/testdata/format/linksInHeaders.kt b/core/testdata/format/linksInHeaders.kt deleted file mode 100644 index 18efd34b..00000000 --- a/core/testdata/format/linksInHeaders.kt +++ /dev/null @@ -1,24 +0,0 @@ -/** - * Some class with really useless documentation. - * - * # Beer o'clock - time to go to the [Bar] - * - * ## But __is [it](isitbeeroclock.com)__ really? - * - * ### [Bar.hello] to the [Bar.world]! - * - * #### _Kotlin is amazing, [Bar.none]_ - * - * ##### We need to go [Bar.deeper] - * - * ###### End of the [Bar.line] - we need to go back! - */ -class Bar { - fun foo() {} - fun hello() {} - fun world() {} - fun kotlin() {} - fun none() {} - fun deeper() {} - fun line() {} -} diff --git a/core/testdata/format/linksInHeaders.md b/core/testdata/format/linksInHeaders.md deleted file mode 100644 index 2f18d442..00000000 --- a/core/testdata/format/linksInHeaders.md +++ /dev/null @@ -1,34 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -Some class with really useless documentation. - -# Beer o'clock - time to go to the [Bar](./index.md) - -## But **is [it](isitbeeroclock.com)** really? - -### [Bar.hello](hello.md) to the [Bar.world](world.md)! - -#### *Kotlin is amazing, [Bar.none](none.md)* - -##### We need to go [Bar.deeper](deeper.md) - -###### End of the [Bar.line](line.md) - we need to go back! - -### Constructors - -| [<init>](-init-.md) | Some class with really useless documentation.`Bar()` | - -### Functions - -| [deeper](deeper.md) | `fun deeper(): Unit` | -| [foo](foo.md) | `fun foo(): Unit` | -| [hello](hello.md) | `fun hello(): Unit` | -| [kotlin](kotlin.md) | `fun kotlin(): Unit` | -| [line](line.md) | `fun line(): Unit` | -| [none](none.md) | `fun none(): Unit` | -| [world](world.md) | `fun world(): Unit` | - diff --git a/core/testdata/format/linksInStrong.kt b/core/testdata/format/linksInStrong.kt deleted file mode 100644 index b9e295ec..00000000 --- a/core/testdata/format/linksInStrong.kt +++ /dev/null @@ -1,13 +0,0 @@ -/** - * A strong class. - * - * __This class [Bar] is awesome.__ - * - * __Even more awesomer is the function [Bar.foo]__ - * - * __[Bar.hello] is also OK__ - */ -class Bar { - fun foo() {} - fun hello() {} -} diff --git a/core/testdata/format/linksInStrong.md b/core/testdata/format/linksInStrong.md deleted file mode 100644 index d234937b..00000000 --- a/core/testdata/format/linksInStrong.md +++ /dev/null @@ -1,23 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -A strong class. - -**This class [Bar](./index.md) is awesome.** - -**Even more awesomer is the function [Bar.foo](foo.md)** - -**[Bar.hello](hello.md) is also OK** - -### Constructors - -| [<init>](-init-.md) | A strong class.`Bar()` | - -### Functions - -| [foo](foo.md) | `fun foo(): Unit` | -| [hello](hello.md) | `fun hello(): Unit` | - diff --git a/core/testdata/format/markdownInLinks.html b/core/testdata/format/markdownInLinks.html deleted file mode 100644 index f1146ea0..00000000 --- a/core/testdata/format/markdownInLinks.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p><a href="https://www.ibm.com">a<strong>b</strong><strong>d</strong> kas </a></p> -</BODY> -</HTML> diff --git a/core/testdata/format/markdownInLinks.kt b/core/testdata/format/markdownInLinks.kt deleted file mode 100644 index 380727ee..00000000 --- a/core/testdata/format/markdownInLinks.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * [a**b**__d__ kas ](https://www.ibm.com) - */ -fun foo() {} diff --git a/core/testdata/format/memberExtension.kt b/core/testdata/format/memberExtension.kt deleted file mode 100644 index 955794d1..00000000 --- a/core/testdata/format/memberExtension.kt +++ /dev/null @@ -1,8 +0,0 @@ -open class X - -class Foo : X - -class Bar { - fun X.y() = "" - fun Foo.x() = "" -} diff --git a/core/testdata/format/memberExtension.md b/core/testdata/format/memberExtension.md deleted file mode 100644 index f52b46f2..00000000 --- a/core/testdata/format/memberExtension.md +++ /dev/null @@ -1,10 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo : `[`X`](../-x/index.md) - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - diff --git a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/js.kt b/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/js.kt deleted file mode 100644 index d7fbf924..00000000 --- a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/js.kt +++ /dev/null @@ -1,7 +0,0 @@ -package pack - -class Some { - fun magic() { - - } -}
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/jvm.kt b/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/jvm.kt deleted file mode 100644 index 57f36742..00000000 --- a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/jvm.kt +++ /dev/null @@ -1,9 +0,0 @@ -package pack - -class SomeCoolJvmClass { - fun magic() { - - } -} - -typealias Some = SomeCoolJvmClass
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/multiplatform.md b/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/multiplatform.md deleted file mode 100644 index d70f9d8b..00000000 --- a/core/testdata/format/multiplatform/breadcrumbsInMemberOfMemberOfGroupNode/multiplatform.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../../index.md) / [pack](../index.md) / [Some](index.md) / [magic](./magic.md) - -# magic - -(JS) `fun magic(): Unit`
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/groupNode/js.kt b/core/testdata/format/multiplatform/groupNode/js.kt deleted file mode 100644 index 045f3f0d..00000000 --- a/core/testdata/format/multiplatform/groupNode/js.kt +++ /dev/null @@ -1,8 +0,0 @@ -package pack - -class Some { - - fun magic() { - - } -}
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/groupNode/jvm.kt b/core/testdata/format/multiplatform/groupNode/jvm.kt deleted file mode 100644 index 57f36742..00000000 --- a/core/testdata/format/multiplatform/groupNode/jvm.kt +++ /dev/null @@ -1,9 +0,0 @@ -package pack - -class SomeCoolJvmClass { - fun magic() { - - } -} - -typealias Some = SomeCoolJvmClass
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/groupNode/multiplatform.md b/core/testdata/format/multiplatform/groupNode/multiplatform.md deleted file mode 100644 index d8b577ca..00000000 --- a/core/testdata/format/multiplatform/groupNode/multiplatform.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [pack](../index.md) / [Some](./index.md) - -# Some - -(JVM) `typealias Some = SomeCoolJvmClass`(JS) `class Some` - -### Constructors - -| (JS) [<init>](-init-.md) | `Some()` | - -### Functions - -| (JS) [magic](magic.md) | `fun magic(): Unit` | - diff --git a/core/testdata/format/multiplatform/groupNode/multiplatform.package.md b/core/testdata/format/multiplatform/groupNode/multiplatform.package.md deleted file mode 100644 index cf1f70f0..00000000 --- a/core/testdata/format/multiplatform/groupNode/multiplatform.package.md +++ /dev/null @@ -1,9 +0,0 @@ -[test](../index.md) / [pack](./index.md) - -## Package pack - -### Types - -| [Some](-some/index.md) | (JVM) `typealias Some = SomeCoolJvmClass`<br>(JS) `class Some` | -| (JVM) [SomeCoolJvmClass](-some-cool-jvm-class/index.md) | `class SomeCoolJvmClass` | - diff --git a/core/testdata/format/multiplatform/implied/foo.md b/core/testdata/format/multiplatform/implied/foo.md deleted file mode 100644 index c261df36..00000000 --- a/core/testdata/format/multiplatform/implied/foo.md +++ /dev/null @@ -1,24 +0,0 @@ -[test](../../index.md) / [foo](../index.md) / [Foo](./index.md) - -# Foo - -(JVM, JS) `class Foo` - -This is a foo. - -### Constructors - -| (JVM, JS) [<init>](-init-.md) | This is a foo.`<init>()` | - -### Properties - -| (JS) [propJs](prop-js.md) | `val propJs: String` | -| (JVM) [propJvm](prop-jvm.md) | `val propJvm: String` | -| (JVM, JS) [propJvmAndJs](prop-jvm-and-js.md) | `val propJvmAndJs: Int` | - -### Functions - -| (JVM, JS) [bothJvmAndJs](both-jvm-and-js.md) | `fun bothJvmAndJs(): Unit` | -| (JS) [js](js.md) | `fun js(): Unit` | -| (JVM) [jvm](jvm.md) | `fun jvm(): Unit` | - diff --git a/core/testdata/format/multiplatform/implied/js.kt b/core/testdata/format/multiplatform/implied/js.kt deleted file mode 100644 index dd2de5bc..00000000 --- a/core/testdata/format/multiplatform/implied/js.kt +++ /dev/null @@ -1,16 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - fun bothJvmAndJs() { - } - - fun js() { - } - - val propJvmAndJs = 0 - - val propJs = "abc" -} diff --git a/core/testdata/format/multiplatform/implied/jvm.kt b/core/testdata/format/multiplatform/implied/jvm.kt deleted file mode 100644 index 8d73ce25..00000000 --- a/core/testdata/format/multiplatform/implied/jvm.kt +++ /dev/null @@ -1,16 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - fun bothJvmAndJs() { - } - - fun jvm() { - } - - val propJvmAndJs = 0 - - val propJvm = "abc" -} diff --git a/core/testdata/format/multiplatform/merge/js.kt b/core/testdata/format/multiplatform/merge/js.kt deleted file mode 100644 index bbf1dd7c..00000000 --- a/core/testdata/format/multiplatform/merge/js.kt +++ /dev/null @@ -1,7 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { -} diff --git a/core/testdata/format/multiplatform/merge/jvm.kt b/core/testdata/format/multiplatform/merge/jvm.kt deleted file mode 100644 index cb77273f..00000000 --- a/core/testdata/format/multiplatform/merge/jvm.kt +++ /dev/null @@ -1,8 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - -} diff --git a/core/testdata/format/multiplatform/merge/multiplatform.package.md b/core/testdata/format/multiplatform/merge/multiplatform.package.md deleted file mode 100644 index 60ed85c4..00000000 --- a/core/testdata/format/multiplatform/merge/multiplatform.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./index.md) - -## Package foo - -### Types - -| (JVM, JS) [Foo](-foo/index.md) | This is a foo.`class Foo` | - diff --git a/core/testdata/format/multiplatform/mergeMembers/foo.md b/core/testdata/format/multiplatform/mergeMembers/foo.md deleted file mode 100644 index c261df36..00000000 --- a/core/testdata/format/multiplatform/mergeMembers/foo.md +++ /dev/null @@ -1,24 +0,0 @@ -[test](../../index.md) / [foo](../index.md) / [Foo](./index.md) - -# Foo - -(JVM, JS) `class Foo` - -This is a foo. - -### Constructors - -| (JVM, JS) [<init>](-init-.md) | This is a foo.`<init>()` | - -### Properties - -| (JS) [propJs](prop-js.md) | `val propJs: String` | -| (JVM) [propJvm](prop-jvm.md) | `val propJvm: String` | -| (JVM, JS) [propJvmAndJs](prop-jvm-and-js.md) | `val propJvmAndJs: Int` | - -### Functions - -| (JVM, JS) [bothJvmAndJs](both-jvm-and-js.md) | `fun bothJvmAndJs(): Unit` | -| (JS) [js](js.md) | `fun js(): Unit` | -| (JVM) [jvm](jvm.md) | `fun jvm(): Unit` | - diff --git a/core/testdata/format/multiplatform/mergeMembers/js.kt b/core/testdata/format/multiplatform/mergeMembers/js.kt deleted file mode 100644 index dd2de5bc..00000000 --- a/core/testdata/format/multiplatform/mergeMembers/js.kt +++ /dev/null @@ -1,16 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - fun bothJvmAndJs() { - } - - fun js() { - } - - val propJvmAndJs = 0 - - val propJs = "abc" -} diff --git a/core/testdata/format/multiplatform/mergeMembers/jvm.kt b/core/testdata/format/multiplatform/mergeMembers/jvm.kt deleted file mode 100644 index 8d73ce25..00000000 --- a/core/testdata/format/multiplatform/mergeMembers/jvm.kt +++ /dev/null @@ -1,16 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - fun bothJvmAndJs() { - } - - fun jvm() { - } - - val propJvmAndJs = 0 - - val propJvm = "abc" -} diff --git a/core/testdata/format/multiplatform/omitRedundant/foo.md b/core/testdata/format/multiplatform/omitRedundant/foo.md deleted file mode 100644 index 5ed92d51..00000000 --- a/core/testdata/format/multiplatform/omitRedundant/foo.md +++ /dev/null @@ -1,20 +0,0 @@ -[test](../../index.md) / [foo](../index.md) / [Foo](./index.md) - -# Foo - -(JVM) `class Foo` - -This is a foo. - -### Constructors - -| (JVM) [<init>](-init-.md) | This is a foo.`Foo()` | - -### Properties - -| (JVM) [propJvm](prop-jvm.md) | `val propJvm: String` | - -### Functions - -| (JVM) [jvm](jvm.md) | `fun jvm(): Unit` | - diff --git a/core/testdata/format/multiplatform/omitRedundant/js.kt b/core/testdata/format/multiplatform/omitRedundant/js.kt deleted file mode 100644 index d1b1429c..00000000 --- a/core/testdata/format/multiplatform/omitRedundant/js.kt +++ /dev/null @@ -1,2 +0,0 @@ -package foo - diff --git a/core/testdata/format/multiplatform/omitRedundant/jvm.kt b/core/testdata/format/multiplatform/omitRedundant/jvm.kt deleted file mode 100644 index 35e3c08d..00000000 --- a/core/testdata/format/multiplatform/omitRedundant/jvm.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - fun jvm() { - } - - val propJvm = "abc" -} diff --git a/core/testdata/format/multiplatform/packagePlatformsFromMembers/js.kt b/core/testdata/format/multiplatform/packagePlatformsFromMembers/js.kt deleted file mode 100644 index 86d09289..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsFromMembers/js.kt +++ /dev/null @@ -1,3 +0,0 @@ -package foo.bar - -fun buz() {} diff --git a/core/testdata/format/multiplatform/packagePlatformsFromMembers/jvm.kt b/core/testdata/format/multiplatform/packagePlatformsFromMembers/jvm.kt deleted file mode 100644 index 86d09289..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsFromMembers/jvm.kt +++ /dev/null @@ -1,3 +0,0 @@ -package foo.bar - -fun buz() {} diff --git a/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.index.md b/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.index.md deleted file mode 100644 index 9b0d6b63..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.index.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](./index.md) - -### Packages - -| (JVM, JS) [foo.bar](foo.bar/index.md) | | - -### Index - diff --git a/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.package.md b/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.package.md deleted file mode 100644 index a7fef864..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsFromMembers/multiplatform.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo.bar](./index.md) - -## Package foo.bar - -### Functions - -| (JVM, JS) [buz](buz.md) | `fun buz(): Unit` | - diff --git a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/jvm.kt b/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/jvm.kt deleted file mode 100644 index 27ab1b32..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/jvm.kt +++ /dev/null @@ -1,5 +0,0 @@ -package some - -fun String.buz(): Unit { - -}
\ No newline at end of file diff --git a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.index.md b/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.index.md deleted file mode 100644 index b5543c80..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.index.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](./index.md) - -### Packages - -| (JVM) [some](some/index.md) | | - -### Index - diff --git a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.package.md b/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.package.md deleted file mode 100644 index 6e42d0dc..00000000 --- a/core/testdata/format/multiplatform/packagePlatformsWithExtExtensions/multiplatform.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [some](./index.md) - -## Package some - -### Extensions for External Classes - -| (JVM) [kotlin.String](kotlin.-string/index.md) | | - diff --git a/core/testdata/format/multiplatform/simple/js.kt b/core/testdata/format/multiplatform/simple/js.kt deleted file mode 100644 index e6d66ffd..00000000 --- a/core/testdata/format/multiplatform/simple/js.kt +++ /dev/null @@ -1,7 +0,0 @@ -package foo - -/** - * This is a bar. - */ -class Bar { -} diff --git a/core/testdata/format/multiplatform/simple/jvm.kt b/core/testdata/format/multiplatform/simple/jvm.kt deleted file mode 100644 index cb77273f..00000000 --- a/core/testdata/format/multiplatform/simple/jvm.kt +++ /dev/null @@ -1,8 +0,0 @@ -package foo - -/** - * This is a foo. - */ -class Foo { - -} diff --git a/core/testdata/format/multiplatform/simple/multiplatform.package.md b/core/testdata/format/multiplatform/simple/multiplatform.package.md deleted file mode 100644 index 73f7d1df..00000000 --- a/core/testdata/format/multiplatform/simple/multiplatform.package.md +++ /dev/null @@ -1,9 +0,0 @@ -[test](../index.md) / [foo](./index.md) - -## Package foo - -### Types - -| (JS) [Bar](-bar/index.md) | This is a bar.`class Bar` | -| (JVM) [Foo](-foo/index.md) | This is a foo.`class Foo` | - diff --git a/core/testdata/format/multipleTypeParameterConstraints.kt b/core/testdata/format/multipleTypeParameterConstraints.kt deleted file mode 100644 index 9d085c3c..00000000 --- a/core/testdata/format/multipleTypeParameterConstraints.kt +++ /dev/null @@ -1,11 +0,0 @@ -interface A { - -} - -interface B { - -} - - -fun f<T> where T : A, T : B { -} diff --git a/core/testdata/format/multipleTypeParameterConstraints.md b/core/testdata/format/multipleTypeParameterConstraints.md deleted file mode 100644 index 27581598..00000000 --- a/core/testdata/format/multipleTypeParameterConstraints.md +++ /dev/null @@ -1,18 +0,0 @@ -<!-- File: test/--root--/-a.md --> -[test](../index.md) / [A](./-a.md) - -# A - -`interface A` -<!-- File: test/--root--/-b.md --> -[test](../index.md) / [B](./-b.md) - -# B - -`interface B` -<!-- File: test/--root--/f.md --> -[test](../index.md) / [f](./f.md) - -# f - -`fun <T> f(): Unit where T : `[`A`](-a.md)`, T : `[`B`](-b.md)
\ No newline at end of file diff --git a/core/testdata/format/nestedLists.kt b/core/testdata/format/nestedLists.kt deleted file mode 100644 index 83217f8a..00000000 --- a/core/testdata/format/nestedLists.kt +++ /dev/null @@ -1,31 +0,0 @@ -/** - * Usage instructions: - * - * - __Rinse__ - * 1. Alter any rinse options _(optional)_ - * - Recommended to [Bar.useSoap] - * - Optionally apply [Bar.elbowGrease] for best results - * 2. [Bar.rinse] to begin rinse - * 1. Thus you should call [Bar.rinse] - * 2. *Then* call [Bar.repeat] - * - Don't forget to use: - * - Soap - * - Elbow Grease - * 3. Finally, adjust soap usage [Bar.useSoap] as needed - * 3. Repeat with [Bar.repeat] - * - * - __Repeat__ - * - Will use previously used rinse options - * - [Bar.rinse] must have been called once before - * - Can be repeated any number of times - * - Options include: - * - [Bar.useSoap] - * - [Bar.useElbowGrease] - */ -class Bar { - fun rinse() = Unit - fun repeat() = Unit - - var useSoap = false - var useElbowGrease = false -} diff --git a/core/testdata/format/nestedLists.md b/core/testdata/format/nestedLists.md deleted file mode 100644 index 6b8de8dc..00000000 --- a/core/testdata/format/nestedLists.md +++ /dev/null @@ -1,43 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -Usage instructions: - -* **Rinse** - 1. Alter any rinse options *(optional)* - * Recommended to [Bar.useSoap](use-soap.md) - * Optionally apply [Bar.elbowGrease](#) for best results - 2. [Bar.rinse](rinse.md) to begin rinse - 1. Thus you should call [Bar.rinse](rinse.md) - 2. *Then* call [Bar.repeat](repeat.md) - * Don't forget to use: - * Soap - * Elbow Grease - 3. Finally, adjust soap usage [Bar.useSoap](use-soap.md) as needed - 3. Repeat with [Bar.repeat](repeat.md) - -* **Repeat** - * Will use previously used rinse options - * [Bar.rinse](rinse.md) must have been called once before - * Can be repeated any number of times - * Options include: - * [Bar.useSoap](use-soap.md) - * [Bar.useElbowGrease](use-elbow-grease.md) - -### Constructors - -| [<init>](-init-.md) | Usage instructions:`Bar()` | - -### Properties - -| [useElbowGrease](use-elbow-grease.md) | `var useElbowGrease: Boolean` | -| [useSoap](use-soap.md) | `var useSoap: Boolean` | - -### Functions - -| [repeat](repeat.md) | `fun repeat(): Unit` | -| [rinse](rinse.md) | `fun rinse(): Unit` | - diff --git a/core/testdata/format/newlineInTableCell.kt b/core/testdata/format/newlineInTableCell.kt deleted file mode 100644 index 3e0616f0..00000000 --- a/core/testdata/format/newlineInTableCell.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * There is `long long int` story - * full of - * new lines - */ -class A
\ No newline at end of file diff --git a/core/testdata/format/newlineInTableCell.package.md b/core/testdata/format/newlineInTableCell.package.md deleted file mode 100644 index 6ed783b3..00000000 --- a/core/testdata/format/newlineInTableCell.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Types - -| [A](-a/index.md) | There is `long long int` story full of new lines`class A` | - diff --git a/core/testdata/format/notPublishedTypeAliasAutoExpansion.kt b/core/testdata/format/notPublishedTypeAliasAutoExpansion.kt deleted file mode 100644 index 1f29e110..00000000 --- a/core/testdata/format/notPublishedTypeAliasAutoExpansion.kt +++ /dev/null @@ -1,13 +0,0 @@ - -class A -class B - - -internal typealias TA = A -private typealias TB = B - -/** - * Correct ref [TA] - * Correct ref [TB] - */ -fun foo() {}
\ No newline at end of file diff --git a/core/testdata/format/notPublishedTypeAliasAutoExpansion.md b/core/testdata/format/notPublishedTypeAliasAutoExpansion.md deleted file mode 100644 index 75b6db3e..00000000 --- a/core/testdata/format/notPublishedTypeAliasAutoExpansion.md +++ /dev/null @@ -1,9 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): Unit` - -Correct ref [TA](-a/index.md) -Correct ref [TB](-b/index.md) - diff --git a/core/testdata/format/nullability.kt b/core/testdata/format/nullability.kt deleted file mode 100644 index d1d4545b..00000000 --- a/core/testdata/format/nullability.kt +++ /dev/null @@ -1,5 +0,0 @@ -class C<T> { - fun foo(): Comparable<T>? { - return null - } -} diff --git a/core/testdata/format/nullability.md b/core/testdata/format/nullability.md deleted file mode 100644 index 2acd6f65..00000000 --- a/core/testdata/format/nullability.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [C](./index.md) - -# C - -`class C<T>` - -### Constructors - -| [<init>](-init-.md) | `C()` | - -### Functions - -| [foo](foo.md) | `fun foo(): Comparable<`[`T`](index.md#T)`>?` | - diff --git a/core/testdata/format/nullableTypeParameterFunction.kt b/core/testdata/format/nullableTypeParameterFunction.kt deleted file mode 100644 index 01805a7b..00000000 --- a/core/testdata/format/nullableTypeParameterFunction.kt +++ /dev/null @@ -1,8 +0,0 @@ -class Bar<T> { - val dataList = mutableListOf<T>() - - open fun checkElement( - elem: T, - addFunc: ((elem: T) -> Unit)? = { dataList.add(it) } - ): Int = 1 -}
\ No newline at end of file diff --git a/core/testdata/format/nullableTypeParameterFunction.md b/core/testdata/format/nullableTypeParameterFunction.md deleted file mode 100644 index ec968537..00000000 --- a/core/testdata/format/nullableTypeParameterFunction.md +++ /dev/null @@ -1,18 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar<T>` - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Properties - -| [dataList](data-list.md) | `val dataList: MutableList<`[`T`](index.md#T)`>` | - -### Functions - -| [checkElement](check-element.md) | `fun checkElement(elem: `[`T`](index.md#T)`, addFunc: ((elem: `[`T`](index.md#T)`) -> Unit)? = { dataList.add(it) }): Int` | - diff --git a/core/testdata/format/operatorOverloading.kt b/core/testdata/format/operatorOverloading.kt deleted file mode 100644 index 6fe78e45..00000000 --- a/core/testdata/format/operatorOverloading.kt +++ /dev/null @@ -1,3 +0,0 @@ -class C { - fun plus(other: C): C -} diff --git a/core/testdata/format/operatorOverloading.md b/core/testdata/format/operatorOverloading.md deleted file mode 100644 index df8ea182..00000000 --- a/core/testdata/format/operatorOverloading.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../../index.md) / [C](index.md) / [plus](./plus.md) - -# plus - -`fun plus(other: `[`C`](index.md)`): `[`C`](index.md)
\ No newline at end of file diff --git a/core/testdata/format/orderedList.html b/core/testdata/format/orderedList.html deleted file mode 100644 index b84de731..00000000 --- a/core/testdata/format/orderedList.html +++ /dev/null @@ -1,29 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Bar - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">class </span><span class="identifier">Bar</span></code> -<p>Usage instructions:</p> -<ol><li>Rinse</li> -<li>Repeat</li> -</ol> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<p>Usage instructions:</p> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/orderedList.kt b/core/testdata/format/orderedList.kt deleted file mode 100644 index 03681c7a..00000000 --- a/core/testdata/format/orderedList.kt +++ /dev/null @@ -1,8 +0,0 @@ -/** - * Usage instructions: - * - * 1. Rinse - * 1. Repeat - */ -class Bar { -} diff --git a/core/testdata/format/overloads.html b/core/testdata/format/overloads.html deleted file mode 100644 index 8e0693bf..00000000 --- a/core/testdata/format/overloads.html +++ /dev/null @@ -1,25 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>root package - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a><br/> -<br/> -<h2>Package <root></h2> -<h3>Functions</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="f.html">f</a></h4> -</td> -<td> -<p>Performs an action on x.</p> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.Int)/x">x</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.String)/x">x</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/overloads.kt b/core/testdata/format/overloads.kt deleted file mode 100644 index dcd2d097..00000000 --- a/core/testdata/format/overloads.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** Performs an action on x. */ -fun f(x: Int) { } - -/** Performs an action on x. */ -fun f(x: String) { } diff --git a/core/testdata/format/overloadsWithDescription.html b/core/testdata/format/overloadsWithDescription.html deleted file mode 100644 index 329393d1..00000000 --- a/core/testdata/format/overloadsWithDescription.html +++ /dev/null @@ -1,20 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f(kotlin.Int)"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.Int)/x">x</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/> -<a name="$f(kotlin.String)"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.String)/x">x</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>Performs an action on <a href="f.html#$f(kotlin.Int)/x">x</a>.</p> -<p>This is a long description.</p> -<h3>Parameters</h3> -<p><a name="x"></a> -<code>x</code> - the value to perform the action on.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/overloadsWithDescription.kt b/core/testdata/format/overloadsWithDescription.kt deleted file mode 100644 index 740e642f..00000000 --- a/core/testdata/format/overloadsWithDescription.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Performs an action on [x]. - * - * This is a long description. - * @param x the value to perform the action on. - */ -fun f(x: Int) { } - -/** - * Performs an action on [x]. - * - * This is a long description. - * @param x the value to perform the action on. - */ -fun f(x: String) { } diff --git a/core/testdata/format/overloadsWithDifferentDescriptions.html b/core/testdata/format/overloadsWithDifferentDescriptions.html deleted file mode 100644 index c2a348c6..00000000 --- a/core/testdata/format/overloadsWithDifferentDescriptions.html +++ /dev/null @@ -1,25 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f(kotlin.Int)"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.Int)/x">x</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>Performs an action on x.</p> -<p>This is a long description.</p> -<h3>Parameters</h3> -<p><a name="x"></a> -<code>x</code> - the int value to perform the action on.</p> -<a name="$f(kotlin.String)"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier" id="$f(kotlin.String)/x">x</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>Performs an action on x.</p> -<p>This is a long description.</p> -<h3>Parameters</h3> -<p><a name="x"></a> -<code>x</code> - the string value to perform the action on.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/overloadsWithDifferentDescriptions.kt b/core/testdata/format/overloadsWithDifferentDescriptions.kt deleted file mode 100644 index ad3169b0..00000000 --- a/core/testdata/format/overloadsWithDifferentDescriptions.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Performs an action on x. - * - * This is a long description. - * @param x the int value to perform the action on. - */ -fun f(x: Int) { } - -/** - * Performs an action on x. - * - * This is a long description. - * @param x the string value to perform the action on. - */ -fun f(x: String) { } diff --git a/core/testdata/format/overridingFunction.kt b/core/testdata/format/overridingFunction.kt deleted file mode 100644 index d7329489..00000000 --- a/core/testdata/format/overridingFunction.kt +++ /dev/null @@ -1,7 +0,0 @@ -open class C() { - open fun f() {} -} - -class D(): C() { - override fun f() {} -} diff --git a/core/testdata/format/overridingFunction.md b/core/testdata/format/overridingFunction.md deleted file mode 100644 index 91c81410..00000000 --- a/core/testdata/format/overridingFunction.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../../index.md) / [D](index.md) / [f](./f.md) - -# f - -`fun f(): Unit` - -Overrides [C.f](../-c/f.md) - diff --git a/core/testdata/format/paramTag.kt b/core/testdata/format/paramTag.kt deleted file mode 100644 index 47e471f5..00000000 --- a/core/testdata/format/paramTag.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * @param x A string - * @param y A number with a really long description that spans multiple lines and goes - * on and on and is very interesting to read - */ -fun f(x: String, y: Int) {} diff --git a/core/testdata/format/paramTag.md b/core/testdata/format/paramTag.md deleted file mode 100644 index 9a368d3a..00000000 --- a/core/testdata/format/paramTag.md +++ /dev/null @@ -1,12 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`fun f(x: String, y: Int): Unit` - -### Parameters - -`x` - A string - -`y` - A number with a really long description that spans multiple lines and goes - on and on and is very interesting to read
\ No newline at end of file diff --git a/core/testdata/format/parameterAnchor.html b/core/testdata/format/parameterAnchor.html deleted file mode 100644 index e54a066b..00000000 --- a/core/testdata/format/parameterAnchor.html +++ /dev/null @@ -1,17 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>processFiles - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./process-files.html">processFiles</a><br/> -<br/> -<h1>processFiles</h1> -<a name="$processFiles(kotlin.Function0((processFiles.T)))"></a> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">processFiles</span><span class="symbol">(</span><span class="identifier" id="$processFiles(kotlin.Function0((processFiles.T)))/processor">processor</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="process-files.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="process-files.html#T"><span class="identifier">T</span></a><span class="symbol">></span></code> -<p>Runs <a href="process-files.html#$processFiles(kotlin.Function0((processFiles.T)))/processor">processor</a> for each file and collects its results into single list</p> -<h3>Parameters</h3> -<p><a name="processor"></a> -<code>processor</code> - function to receive context for symbol resolution and file for processing</p> -</BODY> -</HTML> diff --git a/core/testdata/format/parameterAnchor.kt b/core/testdata/format/parameterAnchor.kt deleted file mode 100644 index ae36ee4c..00000000 --- a/core/testdata/format/parameterAnchor.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Runs [processor] for each file and collects its results into single list - * @param processor function to receive context for symbol resolution and file for processing - */ -public fun processFiles<T>(processor: () -> T): List<T> { -} diff --git a/core/testdata/format/parenthesis.html b/core/testdata/format/parenthesis.html deleted file mode 100644 index 8f6edbee..00000000 --- a/core/testdata/format/parenthesis.html +++ /dev/null @@ -1,14 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>foo (bar)</p> -</BODY> -</HTML> diff --git a/core/testdata/format/parenthesis.kt b/core/testdata/format/parenthesis.kt deleted file mode 100644 index b906f64a..00000000 --- a/core/testdata/format/parenthesis.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * foo (bar) - */ -fun foo() {} diff --git a/core/testdata/format/propertyVar.kt b/core/testdata/format/propertyVar.kt deleted file mode 100644 index 88be1a7a..00000000 --- a/core/testdata/format/propertyVar.kt +++ /dev/null @@ -1 +0,0 @@ -var x = 1
\ No newline at end of file diff --git a/core/testdata/format/propertyVar.md b/core/testdata/format/propertyVar.md deleted file mode 100644 index 474379d9..00000000 --- a/core/testdata/format/propertyVar.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [x](./x.md) - -# x - -`var x: Int`
\ No newline at end of file diff --git a/core/testdata/format/qualifiedNameLink.kt b/core/testdata/format/qualifiedNameLink.kt deleted file mode 100644 index be82a990..00000000 --- a/core/testdata/format/qualifiedNameLink.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * See [kotlin.apply] for the docs - */ -fun foo() { - -}
\ No newline at end of file diff --git a/core/testdata/format/qualifiedNameLink.md b/core/testdata/format/qualifiedNameLink.md deleted file mode 100644 index 53984037..00000000 --- a/core/testdata/format/qualifiedNameLink.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`fun foo(): Unit` - -See [kotlin.apply](#) for the docs - diff --git a/core/testdata/format/receiverParameterTypeBound.kt b/core/testdata/format/receiverParameterTypeBound.kt deleted file mode 100644 index 2b5f6f17..00000000 --- a/core/testdata/format/receiverParameterTypeBound.kt +++ /dev/null @@ -1,5 +0,0 @@ -open class Foo { -} - -fun <T : Foo> T.xyzzy() { -} diff --git a/core/testdata/format/receiverParameterTypeBound.md b/core/testdata/format/receiverParameterTypeBound.md deleted file mode 100644 index 95f3beec..00000000 --- a/core/testdata/format/receiverParameterTypeBound.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`open class Foo` - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - -### Extension Functions - -| [xyzzy](../xyzzy.md) | `fun <T : `[`Foo`](./index.md)`> `[`T`](../xyzzy.md#T)`.xyzzy(): Unit` | - diff --git a/core/testdata/format/receiverReference.kt b/core/testdata/format/receiverReference.kt deleted file mode 100644 index 3e6e2056..00000000 --- a/core/testdata/format/receiverReference.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Prints [this] - */ -fun String.some() { - println(this) -}
\ No newline at end of file diff --git a/core/testdata/format/receiverReference.md b/core/testdata/format/receiverReference.md deleted file mode 100644 index 96c6ec61..00000000 --- a/core/testdata/format/receiverReference.md +++ /dev/null @@ -1,6 +0,0 @@ -[test](../../index.md) / [kotlin.String](./index.md) - -### Extensions for kotlin.String - -| [some](some.md) | Prints [this](some/-this-.md)`fun String.some(): Unit` | - diff --git a/core/testdata/format/referenceLink.kt b/core/testdata/format/referenceLink.kt deleted file mode 100644 index c6550f04..00000000 --- a/core/testdata/format/referenceLink.kt +++ /dev/null @@ -1,16 +0,0 @@ -package example - -/** - * It is link to [example other func][example] - * - * Sure, it is [example] - * - * [example]: example.someOtherFunc - */ -fun a() { - -} - -fun someOtherFunc() { - -}
\ No newline at end of file diff --git a/core/testdata/format/referenceLink.md b/core/testdata/format/referenceLink.md deleted file mode 100644 index ee910cbf..00000000 --- a/core/testdata/format/referenceLink.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- File: test/example/a.md --> -[test](../index.md) / [example](index.md) / [a](./a.md) - -# a - -`fun a(): Unit` - -It is link to [example other func](some-other-func.md) - -Sure, it is [example](some-other-func.md) - -<!-- File: test/example/some-other-func.md --> -[test](../index.md) / [example](index.md) / [someOtherFunc](./some-other-func.md) - -# someOtherFunc - -`fun someOtherFunc(): Unit`
\ No newline at end of file diff --git a/core/testdata/format/reifiedTypeParameter.kt b/core/testdata/format/reifiedTypeParameter.kt deleted file mode 100644 index 1b1de359..00000000 --- a/core/testdata/format/reifiedTypeParameter.kt +++ /dev/null @@ -1,3 +0,0 @@ -inline fun f<reified T>(a: () -> String) { - -} diff --git a/core/testdata/format/reifiedTypeParameter.md b/core/testdata/format/reifiedTypeParameter.md deleted file mode 100644 index 7bb406ee..00000000 --- a/core/testdata/format/reifiedTypeParameter.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`inline fun <reified T> f(a: () -> String): Unit`
\ No newline at end of file diff --git a/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.kt b/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.kt deleted file mode 100644 index 84f78dfb..00000000 --- a/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.kt +++ /dev/null @@ -1,3 +0,0 @@ -fun (suspend () -> Unit).foo() { - -}
\ No newline at end of file diff --git a/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.md b/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.md deleted file mode 100644 index 6d449fb4..00000000 --- a/core/testdata/format/renderFunctionalTypeInParenthesisWhenItIsReceiver.md +++ /dev/null @@ -1,6 +0,0 @@ -[test](../../index.md) / [kotlin.coroutines.SuspendFunction0](./index.md) - -### Extensions for kotlin.coroutines.SuspendFunction0 - -| [foo](foo.md) | `fun (suspend () -> Unit).foo(): Unit` | - diff --git a/core/testdata/format/returnWithLink.html b/core/testdata/format/returnWithLink.html deleted file mode 100644 index 9f36d294..00000000 --- a/core/testdata/format/returnWithLink.html +++ /dev/null @@ -1,15 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo(kotlin.String)"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="identifier" id="$foo(kotlin.String)/s1">s1</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code> -<p><strong>Return</strong><br/> -Returns <a href="foo.html#$foo(kotlin.String)/s1">s1</a> and does nothing else.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/returnWithLink.kt b/core/testdata/format/returnWithLink.kt deleted file mode 100644 index 63d1770c..00000000 --- a/core/testdata/format/returnWithLink.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * @return Returns [s1] and does nothing else. - */ -fun foo(s1: String) = s1
\ No newline at end of file diff --git a/core/testdata/format/sampleByFQName.kt b/core/testdata/format/sampleByFQName.kt deleted file mode 100644 index 2c0af092..00000000 --- a/core/testdata/format/sampleByFQName.kt +++ /dev/null @@ -1,12 +0,0 @@ -package test - -fun sample() { - println("sample") -} - -/** - * @sample test.sample - */ -fun use() { - -}
\ No newline at end of file diff --git a/core/testdata/format/sampleByFQName.md b/core/testdata/format/sampleByFQName.md deleted file mode 100644 index 7093179d..00000000 --- a/core/testdata/format/sampleByFQName.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- File: test/test/sample.md --> -[test](../index.md) / [test](index.md) / [sample](./sample.md) - -# sample - -`fun sample(): Unit` -<!-- File: test/test/use.md --> -[test](../index.md) / [test](index.md) / [use](./use.md) - -# use - -`fun use(): Unit` - -``` kotlin -println("sample") -``` - diff --git a/core/testdata/format/sampleByShortName.kt b/core/testdata/format/sampleByShortName.kt deleted file mode 100644 index 2e03310f..00000000 --- a/core/testdata/format/sampleByShortName.kt +++ /dev/null @@ -1,12 +0,0 @@ -package test - -fun sample() { - println("sample") -} - -/** - * @sample sample - */ -fun use() { - -}
\ No newline at end of file diff --git a/core/testdata/format/sampleByShortName.md b/core/testdata/format/sampleByShortName.md deleted file mode 100644 index 7093179d..00000000 --- a/core/testdata/format/sampleByShortName.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- File: test/test/sample.md --> -[test](../index.md) / [test](index.md) / [sample](./sample.md) - -# sample - -`fun sample(): Unit` -<!-- File: test/test/use.md --> -[test](../index.md) / [test](index.md) / [use](./use.md) - -# use - -`fun use(): Unit` - -``` kotlin -println("sample") -``` - diff --git a/core/testdata/format/see.html b/core/testdata/format/see.html deleted file mode 100644 index 2a8caf6f..00000000 --- a/core/testdata/format/see.html +++ /dev/null @@ -1,46 +0,0 @@ -<!-- File: test/--root--/quux.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>quux - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./quux.html">quux</a><br/> -<br/> -<h1>quux</h1> -<a name="$quux()"></a> -<code><span class="keyword">fun </span><span class="identifier">quux</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p><strong>See Also</strong><br/> -<p><a href="foo.html">foo</a></p> -<p><a href="bar.html">bar</a></p> -</p> -</BODY> -</HTML> -<!-- File: test/--root--/foo.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -</BODY> -</HTML> -<!-- File: test/--root--/bar.html --> -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>bar - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./bar.html">bar</a><br/> -<br/> -<h1>bar</h1> -<a name="$bar()"></a> -<code><span class="keyword">fun </span><span class="identifier">bar</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -</BODY> -</HTML> diff --git a/core/testdata/format/see.kt b/core/testdata/format/see.kt deleted file mode 100644 index a0b153b0..00000000 --- a/core/testdata/format/see.kt +++ /dev/null @@ -1,12 +0,0 @@ -/** - * @see foo - * @see bar - */ -fun quux() { -} - -fun foo() { -} - -fun bar() { -}
\ No newline at end of file diff --git a/core/testdata/format/shadowedExtensionFunctions.kt b/core/testdata/format/shadowedExtensionFunctions.kt deleted file mode 100644 index 64df1ecb..00000000 --- a/core/testdata/format/shadowedExtensionFunctions.kt +++ /dev/null @@ -1,18 +0,0 @@ -open class Foo { -} - -class Bar : Foo() { -} - -fun Foo.xyzzy() { -} - -fun Foo.shazam() { - -} - -fun Bar.xyzzy() { -} - -fun Bar.shazam(i: Int) { -} diff --git a/core/testdata/format/shadowedExtensionFunctions.md b/core/testdata/format/shadowedExtensionFunctions.md deleted file mode 100644 index 4adfda6a..00000000 --- a/core/testdata/format/shadowedExtensionFunctions.md +++ /dev/null @@ -1,15 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar : `[`Foo`](../-foo/index.md) - -### Constructors - -| [<init>](-init-.md) | `Bar()` | - -### Extension Functions - -| [shazam](../shazam.md) | `fun `[`Bar`](./index.md)`.shazam(i: Int): Unit`<br>`fun `[`Foo`](../-foo/index.md)`.shazam(): Unit` | -| [xyzzy](../xyzzy.md) | `fun `[`Bar`](./index.md)`.xyzzy(): Unit` | - diff --git a/core/testdata/format/sinceKotlin.html b/core/testdata/format/sinceKotlin.html deleted file mode 100644 index 3ca6889a..00000000 --- a/core/testdata/format/sinceKotlin.html +++ /dev/null @@ -1,26 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Since1.1 - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Since1.1</a><br/> -<br/> -<h1>Since1.1</h1> -<code><span class="keyword">class </span><span class="identifier">Since1.1</span></code> -<p>Useful</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -Since: <code>1.1</code></td> -<td> -<p>Useful</p> -<code><span class="identifier">Since1.1</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/sinceKotlin.kt b/core/testdata/format/sinceKotlin.kt deleted file mode 100644 index 1025cf0d..00000000 --- a/core/testdata/format/sinceKotlin.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Useful - */ -@SinceKotlin("1.1") -class `Since1.1`
\ No newline at end of file diff --git a/core/testdata/format/sinceKotlin.md b/core/testdata/format/sinceKotlin.md deleted file mode 100644 index 197be48c..00000000 --- a/core/testdata/format/sinceKotlin.md +++ /dev/null @@ -1,12 +0,0 @@ -[test](../../index.md) / [Since1.1](./index.md) - -# Since1.1 - -`class Since1.1` - -Useful - -### Constructors - -| [<init>](-init-.md)Since: `1.1` | Useful`Since1.1()` | - diff --git a/core/testdata/format/sinceKotlin.package.md b/core/testdata/format/sinceKotlin.package.md deleted file mode 100644 index fa29e019..00000000 --- a/core/testdata/format/sinceKotlin.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Types - -| [Since1.1](-since1.1/index.md) (Since: `1.1`) | Useful`class Since1.1` | - diff --git a/core/testdata/format/sinceKotlinWide.kt b/core/testdata/format/sinceKotlinWide.kt deleted file mode 100644 index fa1eb7de..00000000 --- a/core/testdata/format/sinceKotlinWide.kt +++ /dev/null @@ -1,11 +0,0 @@ -/** - * Useful - */ -@SinceKotlin("1.1") -class `Since1.1` - -/** - * Useful also - */ -@SinceKotlin("1.2") -class `Since1.2`
\ No newline at end of file diff --git a/core/testdata/format/sinceKotlinWide.package.md b/core/testdata/format/sinceKotlinWide.package.md deleted file mode 100644 index d79d593d..00000000 --- a/core/testdata/format/sinceKotlinWide.package.md +++ /dev/null @@ -1,9 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Types - -| [Since1.1](-since1.1/index.md) (Since: `1.1`) | Useful`class Since1.1` | -| [Since1.2](-since1.2/index.md) (Since: `1.2`) | Useful also`class Since1.2` | - diff --git a/core/testdata/format/starProjection.kt b/core/testdata/format/starProjection.kt deleted file mode 100644 index 48d53e47..00000000 --- a/core/testdata/format/starProjection.kt +++ /dev/null @@ -1,3 +0,0 @@ -public fun Iterable<*>.containsFoo(element: Any?): Boolean { - return false -} diff --git a/core/testdata/format/starProjection.md b/core/testdata/format/starProjection.md deleted file mode 100644 index 594a7d72..00000000 --- a/core/testdata/format/starProjection.md +++ /dev/null @@ -1,6 +0,0 @@ -[test](../../index.md) / [kotlin.collections.Iterable](./index.md) - -### Extensions for kotlin.collections.Iterable - -| [containsFoo](contains-foo.md) | `fun Iterable<*>.containsFoo(element: Any?): Boolean` | - diff --git a/core/testdata/format/summarizeSignatures.kt b/core/testdata/format/summarizeSignatures.kt deleted file mode 100644 index 1d875a50..00000000 --- a/core/testdata/format/summarizeSignatures.kt +++ /dev/null @@ -1,20 +0,0 @@ -package kotlin - -class Array<T> -class IntArray -class CharArray - -/** - * Returns true if foo. - */ -fun IntArray.foo(predicate: (Int) -> Boolean): Boolean = false - -/** - * Returns true if foo. - */ -fun CharArray.foo(predicate: (Char) -> Boolean): Boolean = false - -/** - * Returns true if foo. - */ -fun <T> Array<T>.foo(predicate: (T) -> Boolean): Boolean = false diff --git a/core/testdata/format/summarizeSignatures.md b/core/testdata/format/summarizeSignatures.md deleted file mode 100644 index a6755328..00000000 --- a/core/testdata/format/summarizeSignatures.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../index.md) / [kotlin](./index.md) - -## Package kotlin - -### Types - -| [Array](-array/index.md) | `class Array<T>` | -| [CharArray](-char-array/index.md) | `class CharArray` | -| [IntArray](-int-array/index.md) | `class IntArray` | - -### Functions - -| [foo](foo.md) | Returns true if foo.`fun <T> any_array<T>.foo(predicate: (`[`T`](foo.md#T)`) -> Boolean): Boolean` | - diff --git a/core/testdata/format/summarizeSignaturesProperty.kt b/core/testdata/format/summarizeSignaturesProperty.kt deleted file mode 100644 index fbbdd328..00000000 --- a/core/testdata/format/summarizeSignaturesProperty.kt +++ /dev/null @@ -1,20 +0,0 @@ -package kotlin - -class Array<T> -class IntArray -class CharArray - -/** - * Returns true if foo. - */ -val IntArray.foo: Int = 0 - -/** - * Returns true if foo. - */ -val CharArray.foo: Int = 0 - -/** - * Returns true if foo. - */ -val <T> Array<T>.foo: Int = 0 diff --git a/core/testdata/format/summarizeSignaturesProperty.md b/core/testdata/format/summarizeSignaturesProperty.md deleted file mode 100644 index 1070a060..00000000 --- a/core/testdata/format/summarizeSignaturesProperty.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../index.md) / [kotlin](./index.md) - -## Package kotlin - -### Types - -| [Array](-array/index.md) | `class Array<T>` | -| [CharArray](-char-array/index.md) | `class CharArray` | -| [IntArray](-int-array/index.md) | `class IntArray` | - -### Properties - -| [foo](foo.md) | Returns true if foo.`val <T> any_array<T>.foo: Int` | - diff --git a/core/testdata/format/suspendInlineFunction.kt b/core/testdata/format/suspendInlineFunction.kt deleted file mode 100644 index 8af0d11a..00000000 --- a/core/testdata/format/suspendInlineFunction.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * returns 1 - */ -suspend inline fun foo(): Int { - 1 -} diff --git a/core/testdata/format/suspendInlineFunction.md b/core/testdata/format/suspendInlineFunction.md deleted file mode 100644 index 056c8799..00000000 --- a/core/testdata/format/suspendInlineFunction.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [foo](./foo.md) - -# foo - -`suspend fun foo(): Int` - -returns 1 - diff --git a/core/testdata/format/suspendParam.kt b/core/testdata/format/suspendParam.kt deleted file mode 100644 index ea3f56f9..00000000 --- a/core/testdata/format/suspendParam.kt +++ /dev/null @@ -1,3 +0,0 @@ -fun takesSuspendParam(func: suspend () -> Unit) { - -}
\ No newline at end of file diff --git a/core/testdata/format/suspendParam.md b/core/testdata/format/suspendParam.md deleted file mode 100644 index 7bc656f4..00000000 --- a/core/testdata/format/suspendParam.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [takesSuspendParam](./takes-suspend-param.md) - -# takesSuspendParam - -`fun takesSuspendParam(func: suspend () -> Unit): Unit`
\ No newline at end of file diff --git a/core/testdata/format/suspendParam.package.md b/core/testdata/format/suspendParam.package.md deleted file mode 100644 index 3fdb1bc6..00000000 --- a/core/testdata/format/suspendParam.package.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Functions - -| [takesSuspendParam](takes-suspend-param.md) | `fun takesSuspendParam(func: suspend () -> Unit): Unit` | - diff --git a/core/testdata/format/throwsTag.kt b/core/testdata/format/throwsTag.kt deleted file mode 100644 index 29a9c3f7..00000000 --- a/core/testdata/format/throwsTag.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * @throws IllegalArgumentException on Mondays - * @exception NullPointerException on Tuesdays - */ -fun f() {} diff --git a/core/testdata/format/throwsTag.md b/core/testdata/format/throwsTag.md deleted file mode 100644 index 104493a7..00000000 --- a/core/testdata/format/throwsTag.md +++ /dev/null @@ -1,11 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`fun f(): Unit` - -### Exceptions - -`IllegalArgumentException` - on Mondays - -`NullPointerException` - on Tuesdays
\ No newline at end of file diff --git a/core/testdata/format/tokensInEmphasis.kt b/core/testdata/format/tokensInEmphasis.kt deleted file mode 100644 index 39362b37..00000000 --- a/core/testdata/format/tokensInEmphasis.kt +++ /dev/null @@ -1,10 +0,0 @@ -/** - * Another emphasised class. - * - * _This class, [Bar] is just meh._ - * - * _For a semicolon; [Bar.foo] is for you!._ - */ -class Bar { - fun foo() = ";" -} diff --git a/core/testdata/format/tokensInEmphasis.md b/core/testdata/format/tokensInEmphasis.md deleted file mode 100644 index 0dd78dec..00000000 --- a/core/testdata/format/tokensInEmphasis.md +++ /dev/null @@ -1,20 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -Another emphasised class. - -*This class, [Bar](./index.md) is just meh.* - -*For a semicolon; [Bar.foo](foo.md) is for you!.* - -### Constructors - -| [<init>](-init-.md) | Another emphasised class.`Bar()` | - -### Functions - -| [foo](foo.md) | `fun foo(): String` | - diff --git a/core/testdata/format/tokensInHeaders.kt b/core/testdata/format/tokensInHeaders.kt deleted file mode 100644 index df62b024..00000000 --- a/core/testdata/format/tokensInHeaders.kt +++ /dev/null @@ -1,27 +0,0 @@ -/** - * Why did the token cross the road? - * - * # Because it was Beer o'clock @ [The.bar] - * - * ## But __waz *\[sic\]* [it](isitbeeroclock.com)__ really? - * - * ### [The.bar] has? [The.foo]est drinks ever! - * - * #### _[The.kotlinz] is [The.bestests], [Bar.none]_ - * - * ##### So many lame code "puns" (in) [The.house] - * - * ###### End of the?? [Bar.line]! - we need to go back! - */ -class The { - object Bar { - fun none() {} - } - - fun bar() {} - fun foo() {} - fun bestests() {} - fun kotlinz() {} - fun house() {} - fun line() {} -} diff --git a/core/testdata/format/tokensInHeaders.md b/core/testdata/format/tokensInHeaders.md deleted file mode 100644 index 31abd971..00000000 --- a/core/testdata/format/tokensInHeaders.md +++ /dev/null @@ -1,37 +0,0 @@ -[test](../../index.md) / [The](./index.md) - -# The - -`class The` - -Why did the token cross the road? - -# Because it was Beer o'clock @ [The.bar](bar.md) - -## But **waz *\[sic\]* [it](isitbeeroclock.com)** really? - -### [The.bar](bar.md) has? [The.foo](foo.md)est drinks ever! - -#### *[The.kotlinz](kotlinz.md) is [The.bestests](bestests.md), [Bar.none](-bar/none.md)* - -##### So many lame code "puns" (in) [The.house](house.md) - -###### End of the?? [Bar.line](#)! - we need to go back! - -### Types - -| [Bar](-bar/index.md) | `object Bar` | - -### Constructors - -| [<init>](-init-.md) | Why did the token cross the road?`The()` | - -### Functions - -| [bar](bar.md) | `fun bar(): Unit` | -| [bestests](bestests.md) | `fun bestests(): Unit` | -| [foo](foo.md) | `fun foo(): Unit` | -| [house](house.md) | `fun house(): Unit` | -| [kotlinz](kotlinz.md) | `fun kotlinz(): Unit` | -| [line](line.md) | `fun line(): Unit` | - diff --git a/core/testdata/format/tokensInStrong.kt b/core/testdata/format/tokensInStrong.kt deleted file mode 100644 index 596a9ae8..00000000 --- a/core/testdata/format/tokensInStrong.kt +++ /dev/null @@ -1,10 +0,0 @@ -/** - * __YASC: [Yasc] Yet Another Strong Class__ - * - * __This class, [Yasc] *is* just meh.__ - * - * __For a semicolon; [Yasc.foo] is for you!.__ - */ -class Yasc { - fun foo() = ";" -} diff --git a/core/testdata/format/tokensInStrong.md b/core/testdata/format/tokensInStrong.md deleted file mode 100644 index 8a444c8d..00000000 --- a/core/testdata/format/tokensInStrong.md +++ /dev/null @@ -1,20 +0,0 @@ -[test](../../index.md) / [Yasc](./index.md) - -# Yasc - -`class Yasc` - -**YASC: [Yasc](./index.md) Yet Another Strong Class** - -**This class, [Yasc](./index.md) *is* just meh.** - -**For a semicolon; [Yasc.foo](foo.md) is for you!.** - -### Constructors - -| [<init>](-init-.md) | **YASC: [Yasc](./index.md) Yet Another Strong Class**`Yasc()` | - -### Functions - -| [foo](foo.md) | `fun foo(): String` | - diff --git a/core/testdata/format/tripleBackticks.html b/core/testdata/format/tripleBackticks.html deleted file mode 100644 index 7dbdf4f2..00000000 --- a/core/testdata/format/tripleBackticks.html +++ /dev/null @@ -1,16 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>f - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./f.html">f</a><br/> -<br/> -<h1>f</h1> -<a name="$f()"></a> -<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>Description</p> -<pre><code>code sample -</code></pre> -</BODY> -</HTML> diff --git a/core/testdata/format/tripleBackticks.kt b/core/testdata/format/tripleBackticks.kt deleted file mode 100644 index 54dfa6d5..00000000 --- a/core/testdata/format/tripleBackticks.kt +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Description - * ``` - * code sample - * ``` - */ -fun f() {} diff --git a/core/testdata/format/typeAliases.kt b/core/testdata/format/typeAliases.kt deleted file mode 100644 index 9657963e..00000000 --- a/core/testdata/format/typeAliases.kt +++ /dev/null @@ -1,27 +0,0 @@ - -class A -class B -class C<T> - -typealias D = A -typealias E = D - -typealias F = (A) -> B - -typealias G = C<A> -typealias H<T> = C<T> - -typealias I<T> = H<T> -typealias J = H<A> - -typealias K = H<J> - -typealias L = (K, B) -> J - -/** - * Documented - */ -typealias M = A - -@Deprecated("!!!") -typealias N = A
\ No newline at end of file diff --git a/core/testdata/format/typeAliases.md b/core/testdata/format/typeAliases.md deleted file mode 100644 index 755bd18d..00000000 --- a/core/testdata/format/typeAliases.md +++ /dev/null @@ -1,104 +0,0 @@ -<!-- File: test/--root--/-a/index.md --> -[test](../../index.md) / [A](./index.md) - -# A - -`class A` - -### Constructors - -| [<init>](-init-.md) | `A()` | - -<!-- File: test/--root--/-b/index.md --> -[test](../../index.md) / [B](./index.md) - -# B - -`class B` - -### Constructors - -| [<init>](-init-.md) | `B()` | - -<!-- File: test/--root--/-c/index.md --> -[test](../../index.md) / [C](./index.md) - -# C - -`class C<T>` - -### Constructors - -| [<init>](-init-.md) | `C()` | - -<!-- File: test/--root--/-d.md --> -[test](../index.md) / [D](./-d.md) - -# D - -`typealias D = `[`A`](-a/index.md) -<!-- File: test/--root--/-e.md --> -[test](../index.md) / [E](./-e.md) - -# E - -`typealias E = `[`D`](-d.md) -<!-- File: test/--root--/-f.md --> -[test](../index.md) / [F](./-f.md) - -# F - -`typealias F = (`[`A`](-a/index.md)`) -> `[`B`](-b/index.md) -<!-- File: test/--root--/-g.md --> -[test](../index.md) / [G](./-g.md) - -# G - -`typealias G = `[`C`](-c/index.md)`<`[`A`](-a/index.md)`>` -<!-- File: test/--root--/-h.md --> -[test](../index.md) / [H](./-h.md) - -# H - -`typealias H<T> = `[`C`](-c/index.md)`<`[`T`](-h.md#T)`>` -<!-- File: test/--root--/-i.md --> -[test](../index.md) / [I](./-i.md) - -# I - -`typealias I<T> = `[`H`](-h.md)`<`[`T`](-i.md#T)`>` -<!-- File: test/--root--/-j.md --> -[test](../index.md) / [J](./-j.md) - -# J - -`typealias J = `[`H`](-h.md)`<`[`A`](-a/index.md)`>` -<!-- File: test/--root--/-k.md --> -[test](../index.md) / [K](./-k.md) - -# K - -`typealias K = `[`H`](-h.md)`<`[`J`](-j.md)`>` -<!-- File: test/--root--/-l.md --> -[test](../index.md) / [L](./-l.md) - -# L - -`typealias L = (`[`K`](-k.md)`, `[`B`](-b/index.md)`) -> `[`J`](-j.md) -<!-- File: test/--root--/-m.md --> -[test](../index.md) / [M](./-m.md) - -# M - -`typealias M = `[`A`](-a/index.md) - -Documented - -<!-- File: test/--root--/-n.md --> -[test](../index.md) / [N](./-n.md) - -# N - -`typealias ~~N~~ = `[`A`](-a/index.md) -**Deprecated:** !!! - diff --git a/core/testdata/format/typeAliases.package.md b/core/testdata/format/typeAliases.package.md deleted file mode 100644 index 0c083811..00000000 --- a/core/testdata/format/typeAliases.package.md +++ /dev/null @@ -1,21 +0,0 @@ -[test](../index.md) - -## Package <root> - -### Types - -| [A](-a/index.md) | `class A` | -| [B](-b/index.md) | `class B` | -| [C](-c/index.md) | `class C<T>` | -| [D](-d.md) | `typealias D = `[`A`](-a/index.md) | -| [E](-e.md) | `typealias E = `[`D`](-d.md) | -| [F](-f.md) | `typealias F = (`[`A`](-a/index.md)`) -> `[`B`](-b/index.md) | -| [G](-g.md) | `typealias G = `[`C`](-c/index.md)`<`[`A`](-a/index.md)`>` | -| [H](-h.md) | `typealias H<T> = `[`C`](-c/index.md)`<`[`T`](-h.md#T)`>` | -| [I](-i.md) | `typealias I<T> = `[`H`](-h.md)`<`[`T`](-i.md#T)`>` | -| [J](-j.md) | `typealias J = `[`H`](-h.md)`<`[`A`](-a/index.md)`>` | -| [K](-k.md) | `typealias K = `[`H`](-h.md)`<`[`J`](-j.md)`>` | -| [L](-l.md) | `typealias L = (`[`K`](-k.md)`, `[`B`](-b/index.md)`) -> `[`J`](-j.md) | -| [M](-m.md) | Documented`typealias M = `[`A`](-a/index.md) | -| [N](-n.md) | `typealias ~~N~~ = `[`A`](-a/index.md) | - diff --git a/core/testdata/format/typeLink.html b/core/testdata/format/typeLink.html deleted file mode 100644 index 7909be23..00000000 --- a/core/testdata/format/typeLink.html +++ /dev/null @@ -1,24 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>Bar - test</title> -</HEAD> -<BODY> -<a href="../../index.html">test</a> / <a href="./index.html">Bar</a><br/> -<br/> -<h1>Bar</h1> -<code><span class="keyword">class </span><span class="identifier">Bar</span> <span class="symbol">:</span> <a href="../-foo/index.html"><span class="identifier">Foo</span></a></code> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<h4><a href="-init-.html"><init></a></h4> -</td> -<td> -<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code></td> -</tr> -</tbody> -</table> -</BODY> -</HTML> diff --git a/core/testdata/format/typeLink.kt b/core/testdata/format/typeLink.kt deleted file mode 100644 index 966e020e..00000000 --- a/core/testdata/format/typeLink.kt +++ /dev/null @@ -1,5 +0,0 @@ -class Foo() { -} - -class Bar(): Foo { -} diff --git a/core/testdata/format/typeParameterBounds.kt b/core/testdata/format/typeParameterBounds.kt deleted file mode 100644 index 8604e3b9..00000000 --- a/core/testdata/format/typeParameterBounds.kt +++ /dev/null @@ -1,7 +0,0 @@ - -/** - * generic function - * @param T the first type parameter - */ -public fun <T : R, R> generic() { -}
\ No newline at end of file diff --git a/core/testdata/format/typeParameterBounds.md b/core/testdata/format/typeParameterBounds.md deleted file mode 100644 index 0e207763..00000000 --- a/core/testdata/format/typeParameterBounds.md +++ /dev/null @@ -1,11 +0,0 @@ -[test](../index.md) / [generic](./generic.md) - -# generic - -`fun <T : `[`R`](generic.md#R)`, R> generic(): Unit` - -generic function - -### Parameters - -`T` - the first type parameter
\ No newline at end of file diff --git a/core/testdata/format/typeParameterReference.kt b/core/testdata/format/typeParameterReference.kt deleted file mode 100644 index f196112d..00000000 --- a/core/testdata/format/typeParameterReference.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Correct ref to [T] - */ -fun <T> T.tt() { - println("T.tt") -}
\ No newline at end of file diff --git a/core/testdata/format/typeParameterReference.md b/core/testdata/format/typeParameterReference.md deleted file mode 100644 index 0baefba0..00000000 --- a/core/testdata/format/typeParameterReference.md +++ /dev/null @@ -1,8 +0,0 @@ -[test](../index.md) / [tt](./tt.md) - -# tt - -`fun <T> `[`T`](tt.md#T)`.tt(): Unit` - -Correct ref to [T](tt.md#T) - diff --git a/core/testdata/format/typeParameterVariance.kt b/core/testdata/format/typeParameterVariance.kt deleted file mode 100644 index d45e7eb3..00000000 --- a/core/testdata/format/typeParameterVariance.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * @param T the class parameter type - */ -class Foo<out T> { -} diff --git a/core/testdata/format/typeParameterVariance.md b/core/testdata/format/typeParameterVariance.md deleted file mode 100644 index 9ea5feda..00000000 --- a/core/testdata/format/typeParameterVariance.md +++ /dev/null @@ -1,14 +0,0 @@ -[test](../../index.md) / [Foo](./index.md) - -# Foo - -`class Foo<out T>` - -### Parameters - -`T` - the class parameter type - -### Constructors - -| [<init>](-init-.md) | `Foo()` | - diff --git a/core/testdata/format/typeProjectionVariance.kt b/core/testdata/format/typeProjectionVariance.kt deleted file mode 100644 index 85ee344d..00000000 --- a/core/testdata/format/typeProjectionVariance.kt +++ /dev/null @@ -1 +0,0 @@ -fun <T> Array<out T>.foo() {} diff --git a/core/testdata/format/typeProjectionVariance.md b/core/testdata/format/typeProjectionVariance.md deleted file mode 100644 index 082ffdba..00000000 --- a/core/testdata/format/typeProjectionVariance.md +++ /dev/null @@ -1,6 +0,0 @@ -[test](../../index.md) / [kotlin.Array](./index.md) - -### Extensions for kotlin.Array - -| [foo](foo.md) | `fun <T> Array<out `[`T`](foo.md#T)`>.foo(): Unit` | - diff --git a/core/testdata/format/uninterpretedEmphasisCharacters.html b/core/testdata/format/uninterpretedEmphasisCharacters.html deleted file mode 100644 index a5b182b8..00000000 --- a/core/testdata/format/uninterpretedEmphasisCharacters.html +++ /dev/null @@ -1,15 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>foo - test</title> -</HEAD> -<BODY> -<a href="../index.html">test</a> / <a href="./foo.html">foo</a><br/> -<br/> -<h1>foo</h1> -<a name="$foo()"></a> -<code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code> -<p>This is <em>emphasized text</em> but text_with_underscores has to preserve the underscores. -Single stars embedded in a word like Embedded*Star have to be preserved as well.</p> -</BODY> -</HTML> diff --git a/core/testdata/format/uninterpretedEmphasisCharacters.kt b/core/testdata/format/uninterpretedEmphasisCharacters.kt deleted file mode 100644 index 711bb567..00000000 --- a/core/testdata/format/uninterpretedEmphasisCharacters.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * This is _emphasized text_ but text_with_underscores has to preserve the underscores. - * Single stars embedded in a word like Embedded*Star have to be preserved as well. - */ -fun foo() {}
\ No newline at end of file diff --git a/core/testdata/format/unorderedLists.kt b/core/testdata/format/unorderedLists.kt deleted file mode 100644 index a594b89b..00000000 --- a/core/testdata/format/unorderedLists.kt +++ /dev/null @@ -1,36 +0,0 @@ -/** - * Usage summary: - * - * - Rinse - * - Repeat - * - * Usage instructions: - * - * - [Bar.rinse] to rinse - * - Alter any rinse options _(optional)_ - * - To repeat; [Bar.repeat] - * - Can reconfigure options: - * - Soap - * - Elbow Grease - * - Bleach - * - * Rinse options: - * - * - [Bar.useSoap] - * - _recommended_ - * - * - [Bar.useElbowGrease] - * - _warning: requires effort_ - * - * - [Bar.useBleach] - * - __use with caution__ - * - */ -class Bar { - fun rinse() = Unit - fun repeat() = Unit - - var useSoap = false - var useElbowGrease = false - var useBleach = false -} diff --git a/core/testdata/format/unorderedLists.md b/core/testdata/format/unorderedLists.md deleted file mode 100644 index 1beb2c64..00000000 --- a/core/testdata/format/unorderedLists.md +++ /dev/null @@ -1,47 +0,0 @@ -[test](../../index.md) / [Bar](./index.md) - -# Bar - -`class Bar` - -Usage summary: - -* Rinse -* Repeat - -Usage instructions: - -* [Bar.rinse](rinse.md) to rinse -* Alter any rinse options *(optional)* -* To repeat; [Bar.repeat](repeat.md) - * Can reconfigure options: - * Soap - * Elbow Grease - * Bleach - -Rinse options: - -* [Bar.useSoap](use-soap.md) - * *recommended* - -* [Bar.useElbowGrease](use-elbow-grease.md) - * *warning: requires effort* - -* [Bar.useBleach](use-bleach.md) - * **use with caution** - -### Constructors - -| [<init>](-init-.md) | Usage summary:`Bar()` | - -### Properties - -| [useBleach](use-bleach.md) | `var useBleach: Boolean` | -| [useElbowGrease](use-elbow-grease.md) | `var useElbowGrease: Boolean` | -| [useSoap](use-soap.md) | `var useSoap: Boolean` | - -### Functions - -| [repeat](repeat.md) | `fun repeat(): Unit` | -| [rinse](rinse.md) | `fun rinse(): Unit` | - diff --git a/core/testdata/format/varargsFunction.kt b/core/testdata/format/varargsFunction.kt deleted file mode 100644 index deea127b..00000000 --- a/core/testdata/format/varargsFunction.kt +++ /dev/null @@ -1 +0,0 @@ -fun f(vararg s: String) {} diff --git a/core/testdata/format/varargsFunction.md b/core/testdata/format/varargsFunction.md deleted file mode 100644 index b23760f0..00000000 --- a/core/testdata/format/varargsFunction.md +++ /dev/null @@ -1,5 +0,0 @@ -[test](../index.md) / [f](./f.md) - -# f - -`fun f(vararg s: String): Unit`
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTags/jre7.kt b/core/testdata/format/website-html/dataTags/jre7.kt deleted file mode 100644 index d21b8d7b..00000000 --- a/core/testdata/format/website-html/dataTags/jre7.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jre7New() {} - -fun jre7() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTags/js.kt b/core/testdata/format/website-html/dataTags/js.kt deleted file mode 100644 index b22d7088..00000000 --- a/core/testdata/format/website-html/dataTags/js.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jsNew() {} - -fun js() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTags/jvm.kt b/core/testdata/format/website-html/dataTags/jvm.kt deleted file mode 100644 index 02d04226..00000000 --- a/core/testdata/format/website-html/dataTags/jvm.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jvmNew() {} - -fun jvm() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTags/multiplatform.package.html b/core/testdata/format/website-html/dataTags/multiplatform.package.html deleted file mode 100644 index 99f0b7a2..00000000 --- a/core/testdata/format/website-html/dataTags/multiplatform.package.html +++ /dev/null @@ -1,74 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./index.html">foo</a></div> -<h2>Package foo</h2> -<h3>Functions</h3> -<div class="api-declarations-list"><div class="declarations" data-platform="JVM, JRE7" data-kotlin-version="1.0, 1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag platform tag-value-JRE7" data-tag-version="1.0">JRE7</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="jre7.html">jre7</a></h4> -<div class="summary-group" data-platform="JVM, JRE7" data-kotlin-version="1.0, 1.0"><div data-platform="JVM, JRE7" data-kotlin-version="1.0, 1.0"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">jre7</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM, JRE7" data-kotlin-version="1.1, 1.1"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.1">JVM</div> -<div class="tags__tag platform tag-value-JRE7" data-tag-version="1.1">JRE7</div> -<div class="tags__tag kotlin-version">1.1</div> -</div> -<h4><a href="jre7-new.html">jre7New</a></h4> -<div class="summary-group" data-platform="JVM, JRE7" data-kotlin-version="1.1, 1.1"><div data-platform="JVM, JRE7" data-kotlin-version="1.1, 1.1"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">jre7New</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JS" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="js.html">js</a></h4> -<div class="summary-group" data-platform="JS" data-kotlin-version="1.0"><div data-platform="JS" data-kotlin-version="1.0"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">js</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JS" data-kotlin-version="1.1"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.1">JS</div> -<div class="tags__tag kotlin-version">1.1</div> -</div> -<h4><a href="js-new.html">jsNew</a></h4> -<div class="summary-group" data-platform="JS" data-kotlin-version="1.1"><div data-platform="JS" data-kotlin-version="1.1"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">jsNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="jvm.html">jvm</a></h4> -<div class="summary-group" data-platform="JVM" data-kotlin-version="1.0"><div data-platform="JVM" data-kotlin-version="1.0"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">jvm</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM" data-kotlin-version="1.1"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.1">JVM</div> -<div class="tags__tag kotlin-version">1.1</div> -</div> -<h4><a href="jvm-new.html">jvmNew</a></h4> -<div class="summary-group" data-platform="JVM" data-kotlin-version="1.1"><div data-platform="JVM" data-kotlin-version="1.1"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">jvmNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM, JS, JRE7" data-kotlin-version="1.0, 1.0, 1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag platform tag-value-JRE7" data-tag-version="1.0">JRE7</div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="shared.html">shared</a></h4> -<div class="summary-group" data-platform="JVM, JS, JRE7" data-kotlin-version="1.0, 1.0, 1.0"><div data-platform="JVM, JS, JRE7" data-kotlin-version="1.0, 1.0, 1.0"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">shared</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM, JS, JRE7" data-kotlin-version="1.1, 1.1, 1.1"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.1">JVM</div> -<div class="tags__tag platform tag-value-JRE7" data-tag-version="1.1">JRE7</div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.1">JS</div> -<div class="tags__tag kotlin-version">1.1</div> -</div> -<h4><a href="shared-new.html">sharedNew</a></h4> -<div class="summary-group" data-platform="JVM, JS, JRE7" data-kotlin-version="1.1, 1.1, 1.1"><div data-platform="JVM, JS, JRE7" data-kotlin-version="1.1, 1.1, 1.1"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">sharedNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -</div> diff --git a/core/testdata/format/website-html/dataTagsInGroupNode/jre7.kt b/core/testdata/format/website-html/dataTagsInGroupNode/jre7.kt deleted file mode 100644 index e69de29b..00000000 --- a/core/testdata/format/website-html/dataTagsInGroupNode/jre7.kt +++ /dev/null diff --git a/core/testdata/format/website-html/dataTagsInGroupNode/js.kt b/core/testdata/format/website-html/dataTagsInGroupNode/js.kt deleted file mode 100644 index 045f3f0d..00000000 --- a/core/testdata/format/website-html/dataTagsInGroupNode/js.kt +++ /dev/null @@ -1,8 +0,0 @@ -package pack - -class Some { - - fun magic() { - - } -}
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTagsInGroupNode/jvm.kt b/core/testdata/format/website-html/dataTagsInGroupNode/jvm.kt deleted file mode 100644 index 57f36742..00000000 --- a/core/testdata/format/website-html/dataTagsInGroupNode/jvm.kt +++ /dev/null @@ -1,9 +0,0 @@ -package pack - -class SomeCoolJvmClass { - fun magic() { - - } -} - -typealias Some = SomeCoolJvmClass
\ No newline at end of file diff --git a/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.html b/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.html deleted file mode 100644 index eddee862..00000000 --- a/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.html +++ /dev/null @@ -1,35 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../../index.html">test</a> / <a href="../index.html">pack</a> / <a href="./index.html">Some</a></div> -<h1>Some</h1> -<div class="node-page-main" data-platform="JVM, JS" data-kotlin-version="1.0, 1.0"><div data-platform="JVM" data-kotlin-version="1.0"><a name="pack.Some"></a> -<div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<div class="signature"><code><span class="keyword">typealias </span><span class="identifier">Some</span> <span class="symbol">=</span> <span class="identifier">SomeCoolJvmClass</span></code></div> -</div><div data-platform="JS" data-kotlin-version="1.0"><a name="pack.Some"></a> -<div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<div class="signature"><code><span class="keyword">class </span><span class="identifier">Some</span></code></div> -</div></div> -<h3>Constructors</h3> -<div class="api-declarations-list"><div class="declarations" data-platform="JS" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="-init-.html"><init></a></h4> -<div class="summary-group" data-platform="JS" data-kotlin-version="1.0"><div data-platform="JS" data-kotlin-version="1.0"><div class="signature"><code><span class="identifier">Some</span><span class="symbol">(</span><span class="symbol">)</span></code></div> -</div></div> -</div> -</div> -<h3>Functions</h3> -<div class="api-declarations-list"><div class="declarations" data-platform="JS" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="magic.html">magic</a></h4> -<div class="summary-group" data-platform="JS" data-kotlin-version="1.0"><div data-platform="JS" data-kotlin-version="1.0"><div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -</div></div> -</div> -</div> diff --git a/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.package.html b/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.package.html deleted file mode 100644 index 99aae350..00000000 --- a/core/testdata/format/website-html/dataTagsInGroupNode/multiplatform.package.html +++ /dev/null @@ -1,26 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./index.html">pack</a></div> -<h2>Package pack</h2> -<h3>Types</h3> -<div class="api-declarations-list"><div class="declarations" data-platform="JVM, JS" data-kotlin-version="1.0, 1.0"> -<h4><a href="-some/index.html">Some</a></h4> -<div class="summary-group" data-platform="JVM, JS" data-kotlin-version="1.0, 1.0"><div data-platform="JVM" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<div class="signature"><code><span class="keyword">typealias </span><span class="identifier">Some</span> <span class="symbol">=</span> <span class="identifier">SomeCoolJvmClass</span></code></div> -</div><div data-platform="JS" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JS" data-tag-version="1.0">JS</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<div class="signature"><code><span class="keyword">class </span><span class="identifier">Some</span></code></div> -</div></div> -</div> -<div class="declarations" data-platform="JVM" data-kotlin-version="1.0"><div class="tags"><div class="spacer"></div> -<div class="tags__tag platform tag-value-JVM" data-tag-version="1.0">JVM</div> -<div class="tags__tag kotlin-version">1.0</div> -</div> -<h4><a href="-some-cool-jvm-class/index.html">SomeCoolJvmClass</a></h4> -<div class="summary-group" data-platform="JVM" data-kotlin-version="1.0"><div data-platform="JVM" data-kotlin-version="1.0"><div class="signature"><code><span class="keyword">class </span><span class="identifier">SomeCoolJvmClass</span></code></div> -</div></div> -</div> -</div> diff --git a/core/testdata/format/website-html/dropImport.html b/core/testdata/format/website-html/dropImport.html deleted file mode 100644 index b6748a5c..00000000 --- a/core/testdata/format/website-html/dropImport.html +++ /dev/null @@ -1,15 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./foo.html">foo</a></div> -<h1>foo</h1> -<div class="node-page-main" data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$foo()"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" data-min-compiler-version="1.3"><pre><code class="lang-kotlin">import some.* - -fun main(args: Array<String>) { -//sampleStart - -//sampleEnd -}</code></pre></div> -</div> diff --git a/core/testdata/format/website-html/dropImport.kt b/core/testdata/format/website-html/dropImport.kt deleted file mode 100644 index 7b8d9f4e..00000000 --- a/core/testdata/format/website-html/dropImport.kt +++ /dev/null @@ -1,12 +0,0 @@ -import samples.* -import some.* - -/** - * @sample example1 - */ -fun foo() { -} - -fun example1() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-html/newLinesInImportList.html b/core/testdata/format/website-html/newLinesInImportList.html deleted file mode 100644 index 712b6a4b..00000000 --- a/core/testdata/format/website-html/newLinesInImportList.html +++ /dev/null @@ -1,16 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./foo.html">foo</a></div> -<h1>foo</h1> -<div class="node-page-main" data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$foo()"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" data-min-compiler-version="1.3"><pre><code class="lang-kotlin">import same.* -import some.* - -fun main(args: Array<String>) { -//sampleStart - -//sampleEnd -}</code></pre></div> -</div> diff --git a/core/testdata/format/website-html/newLinesInImportList.kt b/core/testdata/format/website-html/newLinesInImportList.kt deleted file mode 100644 index 836d9f6f..00000000 --- a/core/testdata/format/website-html/newLinesInImportList.kt +++ /dev/null @@ -1,12 +0,0 @@ -import same.* -import some.* - -/** - * @sample example1 - */ -fun foo() { -} - -fun example1() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-html/newLinesInSamples.html b/core/testdata/format/website-html/newLinesInSamples.html deleted file mode 100644 index 7e379c68..00000000 --- a/core/testdata/format/website-html/newLinesInSamples.html +++ /dev/null @@ -1,23 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./foo.html">foo</a></div> -<h1>foo</h1> -<div class="node-page-main" data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$foo()"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" data-min-compiler-version="1.3"><pre><code class="lang-kotlin"> - -fun main(args: Array<String>) { -//sampleStart -val words = listOf("a", "abc", "ab", "def", "abcd") -val byLength = words.groupBy { it.length } - -println(byLength.keys) // [1, 3, 2, 4] -println(byLength.values) // [[a], [abc, def], [ab], [abcd]] - -val mutableByLength: MutableMap<Int, MutableList<String>> = words.groupByTo(mutableMapOf()) { it.length } -// same content as in byLength map, but the map is mutable -println("mutableByLength == byLength is ${mutableByLength == byLength}") // true -//sampleEnd -}</code></pre></div> -</div> diff --git a/core/testdata/format/website-html/newLinesInSamples.kt b/core/testdata/format/website-html/newLinesInSamples.kt deleted file mode 100644 index ee49aefc..00000000 --- a/core/testdata/format/website-html/newLinesInSamples.kt +++ /dev/null @@ -1,19 +0,0 @@ -fun groupBySample() { - val words = listOf("a", "abc", "ab", "def", "abcd") - val byLength = words.groupBy { it.length } - - assertPrints(byLength.keys, "[1, 3, 2, 4]") - assertPrints(byLength.values, "[[a], [abc, def], [ab], [abcd]]") - - val mutableByLength: MutableMap<Int, MutableList<String>> = words.groupByTo(mutableMapOf()) { it.length } - // same content as in byLength map, but the map is mutable - assertTrue(mutableByLength == byLength) -} - - -/** - * @sample groupBySample - */ -fun foo() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-html/overloadGroup.html b/core/testdata/format/website-html/overloadGroup.html deleted file mode 100644 index 808cd606..00000000 --- a/core/testdata/format/website-html/overloadGroup.html +++ /dev/null @@ -1,22 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./magic.html">magic</a></div> -<h1>magic</h1> -<div class="overload-group"data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$magic(kotlin.String)"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="parameterName" id="$magic(kotlin.String)/spell">spell</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> -<h3>Parameters</h3> -<p><a name="spell"></a> -<code>spell</code> - The text of spell, often distributed on scrolls</p> -<p><strong>Return</strong> Spell ID for future casts</p> -</div> -<div class="overload-group"data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$magic(kotlin.Int)"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="parameterName" id="$magic(kotlin.Int)/spell">spell</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> -<h3>Parameters</h3> -<p><a name="spell"></a> -<code>spell</code> - Spell ID of previously casted spell</p> -<p><strong>Return</strong> Spell ID for future casts</p> -</div> diff --git a/core/testdata/format/website-html/overloadGroup.kt b/core/testdata/format/website-html/overloadGroup.kt deleted file mode 100644 index 5bc98e3d..00000000 --- a/core/testdata/format/website-html/overloadGroup.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @param spell The text of spell, often distributed on scrolls - * @return Spell ID for future casts - */ -fun magic(spell: String): Int { - -} - -/** - * @param spell Spell ID of previously casted spell - * @return Spell ID for future casts - */ -fun magic(spell: Int): Int { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-html/returnTag.html b/core/testdata/format/website-html/returnTag.html deleted file mode 100644 index 2e761527..00000000 --- a/core/testdata/format/website-html/returnTag.html +++ /dev/null @@ -1,13 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./index-of.html">indexOf</a></div> -<h1>indexOf</h1> -<div class="node-page-main" data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)"></a> -<div class="signature"><code><span class="keyword">fun </span><a href="-foo/index.html"><span class="identifier">Foo</span></a><span class="symbol">.</span><span class="identifier">indexOf</span><span class="symbol">(</span><br/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/char">char</span><span class="symbol">:</span> <span class="identifier">Char</span><span class="symbol">, </span><br/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/startIndex">startIndex</span><span class="symbol">:</span> <span class="identifier">Int</span> <span class="symbol">=</span> 0<span class="symbol">, </span><br/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/ignoreCase">ignoreCase</span><span class="symbol">:</span> <span class="identifier">Boolean</span> <span class="symbol">=</span> false<br/><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> -<p>Returns the index within this string of the first occurrence of the specified character, starting from the specified <a href="index-of.html#$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/startIndex">startIndex</a>.</p> -<h3>Parameters</h3> -<p><a name="ignoreCase"></a> -<code>ignoreCase</code> - <code>true</code> to ignore character case when matching a character. By default <code>false</code>.</p> -<p><strong>Returns</strong> An index of the first occurrence of <a href="index-of.html#$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/char">char</a> or -1 if none is found.</p> -</div> diff --git a/core/testdata/format/website-html/returnTag.kt b/core/testdata/format/website-html/returnTag.kt deleted file mode 100644 index 669c14f9..00000000 --- a/core/testdata/format/website-html/returnTag.kt +++ /dev/null @@ -1,11 +0,0 @@ -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-html/sample.html b/core/testdata/format/website-html/sample.html deleted file mode 100644 index 479af45c..00000000 --- a/core/testdata/format/website-html/sample.html +++ /dev/null @@ -1,25 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./foo.html">foo</a></div> -<h1>foo</h1> -<div class="overload-group"data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$foo()"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> -<p>Groups elements of the original sequence by the key returned by the given <a href="#">keySelector</a> function -applied to each element and returns a map where each group key is associated with a list of corresponding elements.</p> -<div class="sample" data-min-compiler-version="1.3"><pre><code class="lang-kotlin"> - -fun main(args: Array<String>) { -//sampleStart -if (true) { - println(property) -} -//sampleEnd -}</code></pre></div> -</div> -<div class="overload-group"data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$foo(kotlin.Int)"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="parameterName" id="$foo(kotlin.Int)/i">i</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> -</div> diff --git a/core/testdata/format/website-html/sample.kt b/core/testdata/format/website-html/sample.kt deleted file mode 100644 index a664c2f5..00000000 --- a/core/testdata/format/website-html/sample.kt +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Groups elements of the original sequence by the key returned by the given [keySelector] function - * applied to each element and returns a map where each group key is associated with a list of corresponding elements. - * @sample example1 - */ -fun foo(): Int { - return 0 -} - -fun foo(i: Int): Int { - return 1 -} - -fun example1(node: String) = if (true) { - println(property) -} diff --git a/core/testdata/format/website-html/sampleWithAsserts.html b/core/testdata/format/website-html/sampleWithAsserts.html deleted file mode 100644 index 3febe91e..00000000 --- a/core/testdata/format/website-html/sampleWithAsserts.html +++ /dev/null @@ -1,28 +0,0 @@ -<div class='api-docs-breadcrumbs'><a href="../index.html">test</a> / <a href="./a.html">a</a></div> -<h1>a</h1> -<div class="node-page-main" data-platform="" data-kotlin-version=""><div class="tags"><div class="spacer"></div> -<div class="tags__tag kotlin-version"></div> -</div> -<a name="$a()"></a> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">a</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></div> -<div class="sample" data-min-compiler-version="1.3"><pre><code class="lang-kotlin">import java.io.FileNotFoundException -import java.io.File - -fun main(args: Array<String>) { -//sampleStart -println(a()) // Hello, Work -println("a() == b() is ${a() == b()}") // true -// A eq B -println("a() == b() is ${a() == b()}") // true -// readSomeFile(File("some.txt")) // reading file now will fail -// readSomeFile(File("some.txt")) // will fail with FileNotFoundException - -// readSomeFile(File("some.txt")) // will fail - -fun indented() { - // A neq B - println("a() != b() is ${a() != b()}") // false -} -//sampleEnd -}</code></pre></div> -</div> diff --git a/core/testdata/format/website-html/sampleWithAsserts.kt b/core/testdata/format/website-html/sampleWithAsserts.kt deleted file mode 100644 index bb5848e6..00000000 --- a/core/testdata/format/website-html/sampleWithAsserts.kt +++ /dev/null @@ -1,34 +0,0 @@ -import java.io.FileNotFoundException -import java.io.File - -/** - * @sample sample - */ -fun a(): String { - return "Hello, Work" -} - -fun b(): String { - return "Hello, Rest" -} - -/** - * @throws FileNotFoundException every time - */ -fun readSomeFile(f: File) { - throw FileNotFoundException("BOOM") -} - -fun sample() { - assertPrints(a(), "Hello, Work") - assertTrue(a() == b()) - assertTrue(a() == b(), "A eq B") - assertFails("reading file now") { readSomeFile(File("some.txt")) } - assertFailsWith<FileNotFoundException> { readSomeFile(File("some.txt")) } - - assertFails { readSomeFile(File("some.txt")) } - - fun indented() { - assertFalse(a() != b(), "A neq B") - } -}
\ No newline at end of file diff --git a/core/testdata/format/website-samples/dropImport.kt b/core/testdata/format/website-samples/dropImport.kt deleted file mode 100644 index 7b8d9f4e..00000000 --- a/core/testdata/format/website-samples/dropImport.kt +++ /dev/null @@ -1,12 +0,0 @@ -import samples.* -import some.* - -/** - * @sample example1 - */ -fun foo() { -} - -fun example1() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-samples/dropImport.md b/core/testdata/format/website-samples/dropImport.md deleted file mode 100644 index 1e05678b..00000000 --- a/core/testdata/format/website-samples/dropImport.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo">foo</a></div> - -# foo - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" markdown="1"> - -``` kotlin -import some.* - -fun main(args: Array<String>) { -//sampleStart - -//sampleEnd -} -``` - -</div> diff --git a/core/testdata/format/website-samples/newLinesInImportList.kt b/core/testdata/format/website-samples/newLinesInImportList.kt deleted file mode 100644 index 836d9f6f..00000000 --- a/core/testdata/format/website-samples/newLinesInImportList.kt +++ /dev/null @@ -1,12 +0,0 @@ -import same.* -import some.* - -/** - * @sample example1 - */ -fun foo() { -} - -fun example1() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-samples/newLinesInImportList.md b/core/testdata/format/website-samples/newLinesInImportList.md deleted file mode 100644 index 27d796f8..00000000 --- a/core/testdata/format/website-samples/newLinesInImportList.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo">foo</a></div> - -# foo - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" markdown="1"> - -``` kotlin -import same.* -import some.* - -fun main(args: Array<String>) { -//sampleStart - -//sampleEnd -} -``` - -</div> diff --git a/core/testdata/format/website-samples/newLinesInSamples.kt b/core/testdata/format/website-samples/newLinesInSamples.kt deleted file mode 100644 index ee49aefc..00000000 --- a/core/testdata/format/website-samples/newLinesInSamples.kt +++ /dev/null @@ -1,19 +0,0 @@ -fun groupBySample() { - val words = listOf("a", "abc", "ab", "def", "abcd") - val byLength = words.groupBy { it.length } - - assertPrints(byLength.keys, "[1, 3, 2, 4]") - assertPrints(byLength.values, "[[a], [abc, def], [ab], [abcd]]") - - val mutableByLength: MutableMap<Int, MutableList<String>> = words.groupByTo(mutableMapOf()) { it.length } - // same content as in byLength map, but the map is mutable - assertTrue(mutableByLength == byLength) -} - - -/** - * @sample groupBySample - */ -fun foo() { - -}
\ No newline at end of file diff --git a/core/testdata/format/website-samples/newLinesInSamples.md b/core/testdata/format/website-samples/newLinesInSamples.md deleted file mode 100644 index 5344b983..00000000 --- a/core/testdata/format/website-samples/newLinesInSamples.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo">foo</a></div> - -# foo - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> -<div class="sample" markdown="1"> - -``` kotlin - - -fun main(args: Array<String>) { -//sampleStart -val words = listOf("a", "abc", "ab", "def", "abcd") -val byLength = words.groupBy { it.length } - -println(byLength.keys) // [1, 3, 2, 4] -println(byLength.values) // [[a], [abc, def], [ab], [abcd]] - -val mutableByLength: MutableMap<Int, MutableList<String>> = words.groupByTo(mutableMapOf()) { it.length } -// same content as in byLength map, but the map is mutable -println("mutableByLength == byLength is ${mutableByLength == byLength}") // true -//sampleEnd -} -``` - -</div> diff --git a/core/testdata/format/website-samples/sample.kt b/core/testdata/format/website-samples/sample.kt deleted file mode 100644 index a664c2f5..00000000 --- a/core/testdata/format/website-samples/sample.kt +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Groups elements of the original sequence by the key returned by the given [keySelector] function - * applied to each element and returns a map where each group key is associated with a list of corresponding elements. - * @sample example1 - */ -fun foo(): Int { - return 0 -} - -fun foo(i: Int): Int { - return 1 -} - -fun example1(node: String) = if (true) { - println(property) -} diff --git a/core/testdata/format/website-samples/sample.md b/core/testdata/format/website-samples/sample.md deleted file mode 100644 index b29075a7..00000000 --- a/core/testdata/format/website-samples/sample.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo">foo</a></div> - -# foo - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -Groups elements of the original sequence by the key returned by the given <a href="#">keySelector</a> function -applied to each element and returns a map where each group key is associated with a list of corresponding elements. - -<div class="sample" markdown="1"> - -``` kotlin - - -fun main(args: Array<String>) { -//sampleStart -if (true) { - println(property) -} -//sampleEnd -} -``` - -</div> - -</div> - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="parameterName" id="$foo(kotlin.Int)/i">i</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -</div> diff --git a/core/testdata/format/website-samples/sampleWithAsserts.kt b/core/testdata/format/website-samples/sampleWithAsserts.kt deleted file mode 100644 index bb9732d5..00000000 --- a/core/testdata/format/website-samples/sampleWithAsserts.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @sample sample - */ -fun a(): String { - return "Hello, Work" -} - -fun b(): String { - return "Hello, Rest" -} - -fun sample() { - assertPrints(a(), "Hello, Work") - assertTrue(a() == b()) -}
\ No newline at end of file diff --git a/core/testdata/format/website-samples/sampleWithAsserts.md b/core/testdata/format/website-samples/sampleWithAsserts.md deleted file mode 100644 index c114468a..00000000 --- a/core/testdata/format/website-samples/sampleWithAsserts.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: a - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/a">a</a></div> - -# a - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">a</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></div> -<div class="sample" markdown="1"> - -``` kotlin - - -fun main(args: Array<String>) { -//sampleStart -println(a()) // Hello, Work -println("a() == b() is ${a() == b()}") // true -//sampleEnd -} -``` - -</div> diff --git a/core/testdata/format/website/dataTags/jre7.kt b/core/testdata/format/website/dataTags/jre7.kt deleted file mode 100644 index d21b8d7b..00000000 --- a/core/testdata/format/website/dataTags/jre7.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jre7New() {} - -fun jre7() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website/dataTags/js.kt b/core/testdata/format/website/dataTags/js.kt deleted file mode 100644 index b22d7088..00000000 --- a/core/testdata/format/website/dataTags/js.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jsNew() {} - -fun js() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website/dataTags/jvm.kt b/core/testdata/format/website/dataTags/jvm.kt deleted file mode 100644 index 02d04226..00000000 --- a/core/testdata/format/website/dataTags/jvm.kt +++ /dev/null @@ -1,11 +0,0 @@ -package foo - -@SinceKotlin("1.1") -fun jvmNew() {} - -fun jvm() {} - -fun shared() {} - -@SinceKotlin("1.1") -fun sharedNew() {}
\ No newline at end of file diff --git a/core/testdata/format/website/dataTags/multiplatform.package.md b/core/testdata/format/website/dataTags/multiplatform.package.md deleted file mode 100644 index 1c7fbf66..00000000 --- a/core/testdata/format/website/dataTags/multiplatform.package.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo/index">foo</a></div> - -## Package foo - -### Functions - -<table class="api-docs-table"> -<tbody> -<tr data-platform="JVM" data-jre-version="JRE7"><td markdown="1"> -<a href="test/foo/jre7">jre7</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">jre7</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JVM" data-kotlin-version="Kotlin 1.1" data-jre-version="JRE7"><td markdown="1"> -<a href="test/foo/jre7-new">jre7New</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">jre7New</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JS"><td markdown="1"> -<a href="test/foo/js">js</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">js</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JS" data-kotlin-version="Kotlin 1.1"><td markdown="1"> -<a href="test/foo/js-new">jsNew</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">jsNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JVM"><td markdown="1"> -<a href="test/foo/jvm">jvm</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">jvm</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JVM" data-kotlin-version="Kotlin 1.1"><td markdown="1"> -<a href="test/foo/jvm-new">jvmNew</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">jvmNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JVM, JS" data-jre-version="JRE7"><td markdown="1"> -<a href="test/foo/shared">shared</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">shared</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr><tr data-platform="JVM, JS" data-kotlin-version="Kotlin 1.1" data-jre-version="JRE7"><td markdown="1"> -<a href="test/foo/shared-new">sharedNew</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">sharedNew</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr></tbody> -</table> diff --git a/core/testdata/format/website/dataTagsInGroupNode/jre7.kt b/core/testdata/format/website/dataTagsInGroupNode/jre7.kt deleted file mode 100644 index e69de29b..00000000 --- a/core/testdata/format/website/dataTagsInGroupNode/jre7.kt +++ /dev/null diff --git a/core/testdata/format/website/dataTagsInGroupNode/js.kt b/core/testdata/format/website/dataTagsInGroupNode/js.kt deleted file mode 100644 index 045f3f0d..00000000 --- a/core/testdata/format/website/dataTagsInGroupNode/js.kt +++ /dev/null @@ -1,8 +0,0 @@ -package pack - -class Some { - - fun magic() { - - } -}
\ No newline at end of file diff --git a/core/testdata/format/website/dataTagsInGroupNode/jvm.kt b/core/testdata/format/website/dataTagsInGroupNode/jvm.kt deleted file mode 100644 index 57f36742..00000000 --- a/core/testdata/format/website/dataTagsInGroupNode/jvm.kt +++ /dev/null @@ -1,9 +0,0 @@ -package pack - -class SomeCoolJvmClass { - fun magic() { - - } -} - -typealias Some = SomeCoolJvmClass
\ No newline at end of file diff --git a/core/testdata/format/website/dataTagsInGroupNode/multiplatform.md b/core/testdata/format/website/dataTagsInGroupNode/multiplatform.md deleted file mode 100644 index 78f6adf2..00000000 --- a/core/testdata/format/website/dataTagsInGroupNode/multiplatform.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: pack.Some - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/pack/index">pack</a> / <a href="test/pack/-some/index">Some</a></div> - -# Some - -<div class="overload-group" data-platform="JVM" markdown="1"> - -<div class="signature"><code><span class="keyword">typealias </span><span class="identifier">Some</span> <span class="symbol">=</span> <span class="identifier">SomeCoolJvmClass</span></code></div> - -**Platform and version requirements:** JVM - -</div> - -<div class="overload-group" data-platform="JS" markdown="1"> - -<div class="signature"><code><span class="keyword">class </span><span class="identifier">Some</span></code></div> - -**Platform and version requirements:** JS - -### Constructors - -<table class="api-docs-table"> -<tbody> -<tr> -<td markdown="1"> -<a href="test/pack/-some/-some/-init-"><init></a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="identifier">Some</span><span class="symbol">(</span><span class="symbol">)</span></code></div> - -</td> -</tr> -</tbody> -</table> - -### Functions - -<table class="api-docs-table"> -<tbody> -<tr> -<td markdown="1"> -<a href="test/pack/-some/-some/magic">magic</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></div> - -</td> -</tr> -</tbody> -</table> - -</div> diff --git a/core/testdata/format/website/dataTagsInGroupNode/multiplatform.package.md b/core/testdata/format/website/dataTagsInGroupNode/multiplatform.package.md deleted file mode 100644 index a6e7d63b..00000000 --- a/core/testdata/format/website/dataTagsInGroupNode/multiplatform.package.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: pack - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/pack/index">pack</a></div> - -## Package pack - -### Types - -<table class="api-docs-table"> -<tbody> -<tr data-platform="JS"><td markdown="1"> -<a href="test/pack/-some/index">Some</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">class </span><span class="identifier">Some</span></code></div> - -</td> -</tr><tr data-platform="JVM"><td markdown="1"> -<a href="test/pack/-some-cool-jvm-class/index">SomeCoolJvmClass</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">class </span><span class="identifier">SomeCoolJvmClass</span></code></div> - -</td> -</tr></tbody> -</table> - -### Type Aliases - -<table class="api-docs-table"> -<tbody> -<tr data-platform="JVM"><td markdown="1"> -<a href="test/pack/-some/index">Some</a> -</td> -<td markdown="1"> -<div class="signature"><code><span class="keyword">typealias </span><span class="identifier">Some</span> <span class="symbol">=</span> <span class="identifier">SomeCoolJvmClass</span></code></div> - -</td> -</tr></tbody> -</table> diff --git a/core/testdata/format/website/overloadGroup.kt b/core/testdata/format/website/overloadGroup.kt deleted file mode 100644 index 5bc98e3d..00000000 --- a/core/testdata/format/website/overloadGroup.kt +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @param spell The text of spell, often distributed on scrolls - * @return Spell ID for future casts - */ -fun magic(spell: String): Int { - -} - -/** - * @param spell Spell ID of previously casted spell - * @return Spell ID for future casts - */ -fun magic(spell: Int): Int { - -}
\ No newline at end of file diff --git a/core/testdata/format/website/overloadGroup.md b/core/testdata/format/website/overloadGroup.md deleted file mode 100644 index d81f86bf..00000000 --- a/core/testdata/format/website/overloadGroup.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: magic - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/magic">magic</a></div> - -# magic - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="parameterName" id="$magic(kotlin.String)/spell">spell</span><span class="symbol">:</span> <span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -### Parameters - -<code>spell</code> - The text of spell, often distributed on scrolls - -**Return** -Spell ID for future casts - -</div> - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">magic</span><span class="symbol">(</span><span class="parameterName" id="$magic(kotlin.Int)/spell">spell</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -### Parameters - -<code>spell</code> - Spell ID of previously casted spell - -**Return** -Spell ID for future casts - -</div> diff --git a/core/testdata/format/website/returnTag.kt b/core/testdata/format/website/returnTag.kt deleted file mode 100644 index 669c14f9..00000000 --- a/core/testdata/format/website/returnTag.kt +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index 418babad..00000000 --- a/core/testdata/format/website/returnTag.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/char">char</span><span class="symbol">:</span> <span class="identifier">Char</span><span class="symbol">, </span><br/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/startIndex">startIndex</span><span class="symbol">:</span> <span class="identifier">Int</span> <span class="symbol">=</span> 0<span class="symbol">, </span><br/> <span class="parameterName" id="$indexOf(Foo, kotlin.Char, kotlin.Int, kotlin.Boolean)/ignoreCase">ignoreCase</span><span class="symbol">:</span> <span class="identifier">Boolean</span> <span class="symbol">=</span> false<br/><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></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. - diff --git a/core/testdata/format/website/sample.kt b/core/testdata/format/website/sample.kt deleted file mode 100644 index a664c2f5..00000000 --- a/core/testdata/format/website/sample.kt +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Groups elements of the original sequence by the key returned by the given [keySelector] function - * applied to each element and returns a map where each group key is associated with a list of corresponding elements. - * @sample example1 - */ -fun foo(): Int { - return 0 -} - -fun foo(i: Int): Int { - return 1 -} - -fun example1(node: String) = if (true) { - println(property) -} diff --git a/core/testdata/format/website/sample.md b/core/testdata/format/website/sample.md deleted file mode 100644 index 7c11790f..00000000 --- a/core/testdata/format/website/sample.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: foo - test -layout: api ---- - -<div class='api-docs-breadcrumbs'><a href="test/index">test</a> / <a href="test/foo">foo</a></div> - -# foo - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -Groups elements of the original sequence by the key returned by the given <a href="#">keySelector</a> function -applied to each element and returns a map where each group key is associated with a list of corresponding elements. - -``` kotlin -if (true) { - println(property) -} -``` - -</div> - -<div class="overload-group" markdown="1"> - -<div class="signature"><code><span class="keyword">fun </span><span class="identifier">foo</span><span class="symbol">(</span><span class="parameterName" id="$foo(kotlin.Int)/i">i</span><span class="symbol">:</span> <span class="identifier">Int</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Int</span></code></div> - -</div> diff --git a/core/testdata/functions/annotatedFunction.kt b/core/testdata/functions/annotatedFunction.kt deleted file mode 100644 index f7abbf6c..00000000 --- a/core/testdata/functions/annotatedFunction.kt +++ /dev/null @@ -1,2 +0,0 @@ -@Strictfp fun f() { -} diff --git a/core/testdata/functions/annotatedFunctionWithAnnotationParameters.kt b/core/testdata/functions/annotatedFunctionWithAnnotationParameters.kt deleted file mode 100644 index e559713a..00000000 --- a/core/testdata/functions/annotatedFunctionWithAnnotationParameters.kt +++ /dev/null @@ -1,7 +0,0 @@ -@Target(AnnotationTarget.VALUE_PARAMETER) -@Retention(AnnotationRetention.SOURCE) -@MustBeDocumented -public annotation class Fancy(val size: Int) - - -@Fancy(1) fun f() {} diff --git a/core/testdata/functions/function.kt b/core/testdata/functions/function.kt deleted file mode 100644 index 3ed81dfa..00000000 --- a/core/testdata/functions/function.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Function fn - */ -fun fn() { -}
\ No newline at end of file diff --git a/core/testdata/functions/functionWithAnnotatedParam.kt b/core/testdata/functions/functionWithAnnotatedParam.kt deleted file mode 100644 index f858e671..00000000 --- a/core/testdata/functions/functionWithAnnotatedParam.kt +++ /dev/null @@ -1,7 +0,0 @@ -@Target(AnnotationTarget.VALUE_PARAMETER) -@Retention(AnnotationRetention.SOURCE) -@MustBeDocumented -public annotation class Fancy - -fun function(@Fancy notInlined: () -> Unit) { -} diff --git a/core/testdata/functions/functionWithDefaultParameter.kt b/core/testdata/functions/functionWithDefaultParameter.kt deleted file mode 100644 index 3a3a102f..00000000 --- a/core/testdata/functions/functionWithDefaultParameter.kt +++ /dev/null @@ -1 +0,0 @@ -fun f(x: String = "") {} diff --git a/core/testdata/functions/functionWithNoinlineParam.kt b/core/testdata/functions/functionWithNoinlineParam.kt deleted file mode 100644 index 640bec83..00000000 --- a/core/testdata/functions/functionWithNoinlineParam.kt +++ /dev/null @@ -1,2 +0,0 @@ -fun function(noinline notInlined: () -> Unit) { -} diff --git a/core/testdata/functions/functionWithNotDocumentedAnnotation.kt b/core/testdata/functions/functionWithNotDocumentedAnnotation.kt deleted file mode 100644 index 3c7e2ff9..00000000 --- a/core/testdata/functions/functionWithNotDocumentedAnnotation.kt +++ /dev/null @@ -1,2 +0,0 @@ -@Suppress("FOO") fun f() { -} diff --git a/core/testdata/functions/functionWithParams.kt b/core/testdata/functions/functionWithParams.kt deleted file mode 100644 index 85c49368..00000000 --- a/core/testdata/functions/functionWithParams.kt +++ /dev/null @@ -1,8 +0,0 @@ -/** - * Multiline - * - * Function - * Documentation - */ -fun function(/** parameter */ x: Int) { -}
\ No newline at end of file diff --git a/core/testdata/functions/functionWithReceiver.kt b/core/testdata/functions/functionWithReceiver.kt deleted file mode 100644 index c8473251..00000000 --- a/core/testdata/functions/functionWithReceiver.kt +++ /dev/null @@ -1,11 +0,0 @@ -/** - * Function with receiver - */ -fun String.fn() { -} - -/** - * Function with receiver - */ -fun String.fn(x: Int) { -} diff --git a/core/testdata/functions/genericFunction.kt b/core/testdata/functions/genericFunction.kt deleted file mode 100644 index 05a65070..00000000 --- a/core/testdata/functions/genericFunction.kt +++ /dev/null @@ -1,5 +0,0 @@ - -/** - * generic function - */ -private fun <T> generic() {}
\ No newline at end of file diff --git a/core/testdata/functions/genericFunctionWithConstraints.kt b/core/testdata/functions/genericFunctionWithConstraints.kt deleted file mode 100644 index 5f22f8c5..00000000 --- a/core/testdata/functions/genericFunctionWithConstraints.kt +++ /dev/null @@ -1,6 +0,0 @@ - -/** - * generic function - */ -public fun <T : R, R> generic() { -}
\ No newline at end of file diff --git a/core/testdata/functions/inlineFunction.kt b/core/testdata/functions/inlineFunction.kt deleted file mode 100644 index 64a617a4..00000000 --- a/core/testdata/functions/inlineFunction.kt +++ /dev/null @@ -1,2 +0,0 @@ -inline fun f(a: () -> String) { -} diff --git a/core/testdata/functions/inlineSuspendFunction.kt b/core/testdata/functions/inlineSuspendFunction.kt deleted file mode 100644 index 5f376267..00000000 --- a/core/testdata/functions/inlineSuspendFunction.kt +++ /dev/null @@ -1,2 +0,0 @@ -inline suspend fun f(a: () -> String) { -} diff --git a/core/testdata/functions/sinceKotlin.kt b/core/testdata/functions/sinceKotlin.kt deleted file mode 100644 index cdcd3357..00000000 --- a/core/testdata/functions/sinceKotlin.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Quite useful [String] - */ -@SinceKotlin("1.1") -fun `availableSince1.1`(): String = "1.1 rulezz"
\ No newline at end of file diff --git a/core/testdata/functions/suspendFunction.kt b/core/testdata/functions/suspendFunction.kt deleted file mode 100644 index 49ecca2a..00000000 --- a/core/testdata/functions/suspendFunction.kt +++ /dev/null @@ -1,2 +0,0 @@ -suspend fun f() { -} diff --git a/core/testdata/functions/suspendInlineFunction.kt b/core/testdata/functions/suspendInlineFunction.kt deleted file mode 100644 index 54f65658..00000000 --- a/core/testdata/functions/suspendInlineFunction.kt +++ /dev/null @@ -1,2 +0,0 @@ -suspend inline fun f(a: () -> String) { -} diff --git a/core/testdata/issues/errorClasses.kt b/core/testdata/issues/errorClasses.kt deleted file mode 100644 index 9e966b3a..00000000 --- a/core/testdata/issues/errorClasses.kt +++ /dev/null @@ -1,20 +0,0 @@ - -class Test(var value: String) { - fun brokenApply(v: String) = apply { value = v } - - fun brokenRun(v: String) = run { - value = v - this - } - - fun brokenLet(v: String) = let { - it.value = v - it - } - - fun brokenGenerics() = listOf("a", "b", "c") - - fun working(v: String) = doSomething() - - fun doSomething(): String = "Hello" -}
\ No newline at end of file diff --git a/core/testdata/java/InheritorLinks.java b/core/testdata/java/InheritorLinks.java deleted file mode 100644 index 31658265..00000000 --- a/core/testdata/java/InheritorLinks.java +++ /dev/null @@ -1,7 +0,0 @@ -public class InheritorLinks { - public static class Foo { - } - - public static class Bar extends Foo { - } -} diff --git a/core/testdata/java/InnerClass.java b/core/testdata/java/InnerClass.java deleted file mode 100644 index 0302da9d..00000000 --- a/core/testdata/java/InnerClass.java +++ /dev/null @@ -1,4 +0,0 @@ -class InnerClass { - public class D { - } -} diff --git a/core/testdata/java/annotatedAnnotation.java b/core/testdata/java/annotatedAnnotation.java deleted file mode 100644 index 6296e400..00000000 --- a/core/testdata/java/annotatedAnnotation.java +++ /dev/null @@ -1,6 +0,0 @@ -import java.lang.annotation.*; - -@Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD}) -public @interface Attribute { - String value() default ""; -} diff --git a/core/testdata/java/arrayType.java b/core/testdata/java/arrayType.java deleted file mode 100644 index dc42a207..00000000 --- a/core/testdata/java/arrayType.java +++ /dev/null @@ -1,5 +0,0 @@ -class Test { - public String[] arrayToString(int[] data) { - return null; - } -} diff --git a/core/testdata/java/constants.java b/core/testdata/java/constants.java deleted file mode 100644 index 26f16639..00000000 --- a/core/testdata/java/constants.java +++ /dev/null @@ -1,5 +0,0 @@ -public class Constants { - public static final String constStr = "some value"; - public static final Object nullConst = null; - public static final String refConst = constStr; -}
\ No newline at end of file diff --git a/core/testdata/java/constructors.java b/core/testdata/java/constructors.java deleted file mode 100644 index 6f899d18..00000000 --- a/core/testdata/java/constructors.java +++ /dev/null @@ -1,5 +0,0 @@ -class Test { - public Test() {} - - public Test(String s) {} -} diff --git a/core/testdata/java/deprecation.java b/core/testdata/java/deprecation.java deleted file mode 100644 index be8decd6..00000000 --- a/core/testdata/java/deprecation.java +++ /dev/null @@ -1,6 +0,0 @@ -class C { - /** - * @deprecated This should no longer be used - */ - void fn() {} -}
\ No newline at end of file diff --git a/core/testdata/java/enumValues.java b/core/testdata/java/enumValues.java deleted file mode 100644 index d8dda934..00000000 --- a/core/testdata/java/enumValues.java +++ /dev/null @@ -1,3 +0,0 @@ -enum E { - Foo -}
\ No newline at end of file diff --git a/core/testdata/java/field.java b/core/testdata/java/field.java deleted file mode 100644 index d9ae75f9..00000000 --- a/core/testdata/java/field.java +++ /dev/null @@ -1,4 +0,0 @@ -class Test { - public int i; - public static final String s; -} diff --git a/core/testdata/java/javaLangObject.java b/core/testdata/java/javaLangObject.java deleted file mode 100644 index be3dd570..00000000 --- a/core/testdata/java/javaLangObject.java +++ /dev/null @@ -1,3 +0,0 @@ -class Test { - public Object fn() { return null; } -} diff --git a/core/testdata/java/member.java b/core/testdata/java/member.java deleted file mode 100644 index d4f4b8d5..00000000 --- a/core/testdata/java/member.java +++ /dev/null @@ -1,11 +0,0 @@ -class Test { - /** - * Summary for Function - * @param name is String parameter - * @param value is int parameter - * @author yole - */ - public void fn(String name, int value) { - - } -}
\ No newline at end of file diff --git a/core/testdata/java/memberWithModifiers.java b/core/testdata/java/memberWithModifiers.java deleted file mode 100644 index ea645c21..00000000 --- a/core/testdata/java/memberWithModifiers.java +++ /dev/null @@ -1,12 +0,0 @@ -public abstract class Test { - /** - * Summary for Function - * @param name is String parameter - * @param value is int parameter - */ - protected final void fn(String name, int value) { - - } - - protected void openFn() {} -}
\ No newline at end of file diff --git a/core/testdata/java/staticMethod.java b/core/testdata/java/staticMethod.java deleted file mode 100644 index a2ecd7f1..00000000 --- a/core/testdata/java/staticMethod.java +++ /dev/null @@ -1,4 +0,0 @@ -class C { - public static void foo() { - } -} diff --git a/core/testdata/java/superClass.java b/core/testdata/java/superClass.java deleted file mode 100644 index 31b5fa96..00000000 --- a/core/testdata/java/superClass.java +++ /dev/null @@ -1,2 +0,0 @@ -public class Foo extends Exception implements Cloneable { -} diff --git a/core/testdata/java/suppressTag.java b/core/testdata/java/suppressTag.java deleted file mode 100644 index c26194c8..00000000 --- a/core/testdata/java/suppressTag.java +++ /dev/null @@ -1,10 +0,0 @@ -class C { - public static void foo() { - } - - /** - * @suppress - */ - public static void bar() { - } -} diff --git a/core/testdata/java/typeParameter.java b/core/testdata/java/typeParameter.java deleted file mode 100644 index 5a24b30a..00000000 --- a/core/testdata/java/typeParameter.java +++ /dev/null @@ -1,3 +0,0 @@ -class Foo<T extends Comparable<T>> { - public <E> E foo(); -} diff --git a/core/testdata/java/varargs.java b/core/testdata/java/varargs.java deleted file mode 100644 index d184564e..00000000 --- a/core/testdata/java/varargs.java +++ /dev/null @@ -1,3 +0,0 @@ -class Foo { - public void bar(String... x); -} diff --git a/core/testdata/javadoc/argumentReference.kt b/core/testdata/javadoc/argumentReference.kt deleted file mode 100644 index ac3104e9..00000000 --- a/core/testdata/javadoc/argumentReference.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * [error] - */ -fun argNamedError(error: String) {}
\ No newline at end of file diff --git a/core/testdata/javadoc/blankLineInsideCodeBlock.kt b/core/testdata/javadoc/blankLineInsideCodeBlock.kt deleted file mode 100644 index 9430f4d5..00000000 --- a/core/testdata/javadoc/blankLineInsideCodeBlock.kt +++ /dev/null @@ -1,12 +0,0 @@ -/** - * ``` - * This is a test - * of Dokka's code blocks. - * Here is a blank line. - * - * The previous line was blank. - * ``` - */ -fun u() { - -}
\ No newline at end of file diff --git a/core/testdata/javadoc/bytearr.kt b/core/testdata/javadoc/bytearr.kt deleted file mode 100644 index 84be1a70..00000000 --- a/core/testdata/javadoc/bytearr.kt +++ /dev/null @@ -1,7 +0,0 @@ -package foo - -class ByteArray { - fun foo(): IntArray { - return intArrayOf() - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/companionMethodReference.kt b/core/testdata/javadoc/companionMethodReference.kt deleted file mode 100644 index 499e4492..00000000 --- a/core/testdata/javadoc/companionMethodReference.kt +++ /dev/null @@ -1,13 +0,0 @@ -package foo - - -/** - * Linking to [test] - */ -class TestClass { - - companion object { - - @JvmStatic fun test(arg: String) {} - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/constructorParameters.kt b/core/testdata/javadoc/constructorParameters.kt deleted file mode 100644 index c29ae912..00000000 --- a/core/testdata/javadoc/constructorParameters.kt +++ /dev/null @@ -1,14 +0,0 @@ -package bar - -/** - * Just a fruit - * - * @param weight in grams - * @param ranking quality from 0 to 10, where 10 is best - * @param color yellow is default - */ -class Banana ( - private val weight: Double, - private val ranking: Int, - color: String = "yellow" -)
\ No newline at end of file diff --git a/core/testdata/javadoc/defaultNoArgConstructor.kt b/core/testdata/javadoc/defaultNoArgConstructor.kt deleted file mode 100644 index 3a6d04a5..00000000 --- a/core/testdata/javadoc/defaultNoArgConstructor.kt +++ /dev/null @@ -1,12 +0,0 @@ -package foo - -/** - * Description - * - * @constructor print peach - */ -class Peach { - init { - println("peach") - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/deprecated.java b/core/testdata/javadoc/deprecated.java deleted file mode 100644 index 5a6cdd77..00000000 --- a/core/testdata/javadoc/deprecated.java +++ /dev/null @@ -1,28 +0,0 @@ -package bar; - -/** - * Just a fruit - */ -public class Banana { - private Double weight; - - /** - * Returns weight - * - * @return weight - * @deprecated - */ - public Double getWeight() { - return weight; - } - - /** - * Sets weight - * - * @param weight in grams - * @deprecated with message - */ - public void setWeight(Double weight) { - this.weight = weight; - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/exception.kt b/core/testdata/javadoc/exception.kt deleted file mode 100644 index ec0a5bbb..00000000 --- a/core/testdata/javadoc/exception.kt +++ /dev/null @@ -1,5 +0,0 @@ -package foo - -class MyException : Exception { - fun foo() = "" -} diff --git a/core/testdata/javadoc/functionParameters.java b/core/testdata/javadoc/functionParameters.java deleted file mode 100644 index 8d5f5143..00000000 --- a/core/testdata/javadoc/functionParameters.java +++ /dev/null @@ -1,17 +0,0 @@ -package bar; - -/** - * Foo - */ - -public class Foo { - - /** perfom request - * - * @param name user name - * @param password user password - */ - public void request(String name, String password) { - - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/internal.kt b/core/testdata/javadoc/internal.kt deleted file mode 100644 index a57ea3b4..00000000 --- a/core/testdata/javadoc/internal.kt +++ /dev/null @@ -1,8 +0,0 @@ -package foo - -data class Person internal constructor( - val name: String = "", - val age: Int = 0 -) { - constructor(age: Int): this("", age) -} diff --git a/core/testdata/javadoc/jvmname.kt b/core/testdata/javadoc/jvmname.kt deleted file mode 100644 index e4774cd6..00000000 --- a/core/testdata/javadoc/jvmname.kt +++ /dev/null @@ -1,6 +0,0 @@ -package foo - -class Apple { - @get:JvmName("_tree") - internal val source: Tree -} diff --git a/core/testdata/javadoc/kdocKeywordsOnMethod.kt b/core/testdata/javadoc/kdocKeywordsOnMethod.kt deleted file mode 100644 index df5bbbe0..00000000 --- a/core/testdata/javadoc/kdocKeywordsOnMethod.kt +++ /dev/null @@ -1,12 +0,0 @@ -class FireException : Exception - - -/** - * COMM - * @param a Some string - * @return value of a - * @throws FireException in case of fire - */ -@Throws(FireException::class) -fun my(a: String): String = a - diff --git a/core/testdata/javadoc/noArgConstructor.kt b/core/testdata/javadoc/noArgConstructor.kt deleted file mode 100644 index 25e5548c..00000000 --- a/core/testdata/javadoc/noArgConstructor.kt +++ /dev/null @@ -1,12 +0,0 @@ -package foo - -/** - * Description - * - * @constructor print plum - */ -class Plum() { - init { - println("plum") - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/obj.kt b/core/testdata/javadoc/obj.kt deleted file mode 100644 index 1d10a422..00000000 --- a/core/testdata/javadoc/obj.kt +++ /dev/null @@ -1,7 +0,0 @@ -package foo - -class O { - companion object { - - } -} diff --git a/core/testdata/javadoc/paramlink.kt b/core/testdata/javadoc/paramlink.kt deleted file mode 100644 index 48972a22..00000000 --- a/core/testdata/javadoc/paramlink.kt +++ /dev/null @@ -1,10 +0,0 @@ -package demo - -/** - * You can [eat] it or cut it into slices using [cutIntoPieces] - */ -interface Apple { - fun eat() - - fun cutIntoPieces(pieces: Int) -} diff --git a/core/testdata/javadoc/stringarr.kt b/core/testdata/javadoc/stringarr.kt deleted file mode 100644 index d6cd9dea..00000000 --- a/core/testdata/javadoc/stringarr.kt +++ /dev/null @@ -1,8 +0,0 @@ -package foo - -class Foo { - companion object { - @JvmStatic fun main(args: Array<String>) { - } - } -}
\ No newline at end of file diff --git a/core/testdata/javadoc/suppress.kt b/core/testdata/javadoc/suppress.kt deleted file mode 100644 index 90f6c131..00000000 --- a/core/testdata/javadoc/suppress.kt +++ /dev/null @@ -1,37 +0,0 @@ -/** - * @suppress - */ -class Some { - -} - - -/** - * @suppress - * @author me - * @see other - */ -class SomeAgain { - -} - -class Same { - /** - * @suppress - */ - fun privateApi() { - - } - - /** - * @suppress - */ - val privateForSomeReason = "" -} - -/** - * @suppress - */ -interface Interface { - -}
\ No newline at end of file diff --git a/core/testdata/javadoc/typealiases.kt b/core/testdata/javadoc/typealiases.kt deleted file mode 100644 index bb09bfad..00000000 --- a/core/testdata/javadoc/typealiases.kt +++ /dev/null @@ -1,11 +0,0 @@ -class A - -typealias B = A - -class C : B - -typealias D = (A) -> C - -fun some(d: D) { - -}
\ No newline at end of file diff --git a/core/testdata/javadoc/types.kt b/core/testdata/javadoc/types.kt deleted file mode 100644 index 55be6058..00000000 --- a/core/testdata/javadoc/types.kt +++ /dev/null @@ -1,4 +0,0 @@ -package foo - -fun foo(x: Int, o: Any): String { -} diff --git a/core/testdata/javadoc/vararg.kt b/core/testdata/javadoc/vararg.kt deleted file mode 100644 index aa6c26d7..00000000 --- a/core/testdata/javadoc/vararg.kt +++ /dev/null @@ -1,3 +0,0 @@ -fun vararg(a: String, vararg b: Int) {} - -fun varargInMiddle(a: String, vararg b: Int, c: Short) {}
\ No newline at end of file diff --git a/core/testdata/javadoc/visibilityModifiers.kt b/core/testdata/javadoc/visibilityModifiers.kt deleted file mode 100644 index e48e7f62..00000000 --- a/core/testdata/javadoc/visibilityModifiers.kt +++ /dev/null @@ -1,15 +0,0 @@ -package foo - -abstract class Apple { - protected var name: String = "foo" - internal var weight: Int = 180 - var rating: Int = 10 - private var color: String = "red" - - companion object { - @JvmStatic - val code : Int = 123456 - } - - -}
\ No newline at end of file diff --git a/core/testdata/links/linkToConstantWithUnderscores.kt b/core/testdata/links/linkToConstantWithUnderscores.kt deleted file mode 100644 index 57011bfa..00000000 --- a/core/testdata/links/linkToConstantWithUnderscores.kt +++ /dev/null @@ -1,8 +0,0 @@ -/** - * This is link to [MY_CONSTANT_VALUE] - */ -class Foo { - companion object { - val MY_CONSTANT_VALUE = 0 - } -}
\ No newline at end of file diff --git a/core/testdata/links/linkToExternalSite.kt b/core/testdata/links/linkToExternalSite.kt deleted file mode 100644 index a3d8c5ef..00000000 --- a/core/testdata/links/linkToExternalSite.kt +++ /dev/null @@ -1,4 +0,0 @@ -/** - * This is link to [http://example.com/#example] - */ -class Foo {}
\ No newline at end of file diff --git a/core/testdata/links/linkToJDK.kt b/core/testdata/links/linkToJDK.kt deleted file mode 100644 index e69de29b..00000000 --- a/core/testdata/links/linkToJDK.kt +++ /dev/null diff --git a/core/testdata/links/linkToMember.kt b/core/testdata/links/linkToMember.kt deleted file mode 100644 index b60eaedb..00000000 --- a/core/testdata/links/linkToMember.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * This is link to [member] - */ -class Foo { - fun member() {} -}
\ No newline at end of file diff --git a/core/testdata/links/linkToPackage.kt b/core/testdata/links/linkToPackage.kt deleted file mode 100644 index 3dd86628..00000000 --- a/core/testdata/links/linkToPackage.kt +++ /dev/null @@ -1,8 +0,0 @@ -package test.magic - -/** - * Basic implementations of [Magic] are located in [test.magic] package - */ -abstract class Magic { - -} diff --git a/core/testdata/links/linkToParam.kt b/core/testdata/links/linkToParam.kt deleted file mode 100644 index ca42a742..00000000 --- a/core/testdata/links/linkToParam.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * This is link to [param] - */ -fun Foo(param: String) { -}
\ No newline at end of file diff --git a/core/testdata/links/linkToQualifiedMember.kt b/core/testdata/links/linkToQualifiedMember.kt deleted file mode 100644 index 22c154fe..00000000 --- a/core/testdata/links/linkToQualifiedMember.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * This is link to [Foo.member] - */ -class Foo { - fun member() {} -}
\ No newline at end of file diff --git a/core/testdata/links/linkToSelf.kt b/core/testdata/links/linkToSelf.kt deleted file mode 100644 index 74395f0f..00000000 --- a/core/testdata/links/linkToSelf.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * This is link to [Foo] - */ -class Foo { - -}
\ No newline at end of file diff --git a/core/testdata/markdown/spec.txt b/core/testdata/markdown/spec.txt deleted file mode 100644 index 916bdd89..00000000 --- a/core/testdata/markdown/spec.txt +++ /dev/null @@ -1,6150 +0,0 @@ ---- -title: CommonMark Spec -author: -- John MacFarlane -version: 2 -date: 2014-09-19 -... - -# Introduction - -## What is Markdown? - -Markdown is a plain text format for writing structured documents, -based on conventions used for indicating formatting in email and -usenet posts. It was developed in 2004 by John Gruber, who wrote -the first Markdown-to-HTML converter in perl, and it soon became -widely used in websites. By 2014 there were dozens of -implementations in many languages. Some of them extended basic -Markdown syntax with conventions for footnotes, definition lists, -tables, and other constructs, and some allowed output not just in -HTML but in LaTeX and many other formats. - -## Why is a spec needed? - -John Gruber's [canonical description of Markdown's -syntax](https://daringfireball.net/projects/markdown/syntax) -does not specify the syntax unambiguously. Here are some examples of -questions it does not answer: - -1. How much indentation is needed for a sublist? The spec says that - continuation paragraphs need to be indented four spaces, but is - not fully explicit about sublists. It is natural to think that - they, too, must be indented four spaces, but `Markdown.pl` does - not require that. This is hardly a "corner case," and divergences - between implementations on this issue often lead to surprises for - users in real documents. (See [this comment by John - Gruber](https://article.gmane.org/gmane.text.markdown.general/1997).) - -2. Is a blank line needed before a block quote or header? - Most implementations do not require the blank line. However, - this can lead to unexpected results in hard-wrapped text, and - also to ambiguities in parsing (note that some implementations - put the header inside the blockquote, while others do not). - (John Gruber has also spoken [in favor of requiring the blank - lines](https://article.gmane.org/gmane.text.markdown.general/2146).) - -3. Is a blank line needed before an indented code block? - (`Markdown.pl` requires it, but this is not mentioned in the - documentation, and some implementations do not require it.) - - ``` markdown - paragraph - code? - ``` - -4. What is the exact rule for determining when list items get - wrapped in `<p>` tags? Can a list be partially "loose" and partially - "tight"? What should we do with a list like this? - - ``` markdown - 1. one - - 2. two - 3. three - ``` - - Or this? - - ``` markdown - 1. one - - a - - - b - 2. two - ``` - - (There are some relevant comments by John Gruber - [here](https://article.gmane.org/gmane.text.markdown.general/2554).) - -5. Can list markers be indented? Can ordered list markers be right-aligned? - - ``` markdown - 8. item 1 - 9. item 2 - 10. item 2a - ``` - -6. Is this one list with a horizontal rule in its second item, - or two lists separated by a horizontal rule? - - ``` markdown - * a - * * * * * - * b - ``` - -7. When list markers change from numbers to bullets, do we have - two lists or one? (The Markdown syntax description suggests two, - but the perl scripts and many other implementations produce one.) - - ``` markdown - 1. fee - 2. fie - - foe - - fum - ``` - -8. What are the precedence rules for the markers of inline structure? - For example, is the following a valid link, or does the code span - take precedence ? - - ``` markdown - [a backtick (`)](/url) and [another backtick (`)](/url). - ``` - -9. What are the precedence rules for markers of emphasis and strong - emphasis? For example, how should the following be parsed? - - ``` markdown - *foo *bar* baz* - ``` - -10. What are the precedence rules between block-level and inline-level - structure? For example, how should the following be parsed? - - ``` markdown - - `a long code span can contain a hyphen like this - - and it can screw things up` - ``` - -11. Can list items include headers? (`Markdown.pl` does not allow this, - but headers can occur in blockquotes.) - - ``` markdown - - # Heading - ``` - -12. Can link references be defined inside block quotes or list items? - - ``` markdown - > Blockquote [foo]. - > - > [foo]: /url - ``` - -13. If there are multiple definitions for the same reference, which takes - precedence? - - ``` markdown - [foo]: /url1 - [foo]: /url2 - - [foo][] - ``` - -In the absence of a spec, early implementers consulted `Markdown.pl` -to resolve these ambiguities. But `Markdown.pl` was quite buggy, and -gave manifestly bad results in many cases, so it was not a -satisfactory replacement for a spec. - -Because there is no unambiguous spec, implementations have diverged -considerably. As a result, users are often surprised to find that -a document that renders one way on one system (say, a github wiki) -renders differently on another (say, converting to docbook using -pandoc). To make matters worse, because nothing in Markdown counts -as a "syntax error," the divergence often isn't discovered right away. - -## About this document - -This document attempts to specify Markdown syntax unambiguously. -It contains many examples with side-by-side Markdown and -HTML. These are intended to double as conformance tests. An -accompanying script `runtests.pl` can be used to run the tests -against any Markdown program: - - perl runtests.pl spec.txt PROGRAM - -Since this document describes how Markdown is to be parsed into -an abstract syntax tree, it would have made sense to use an abstract -representation of the syntax tree instead of HTML. But HTML is capable -of representing the structural distinctions we need to make, and the -choice of HTML for the tests makes it possible to run the tests against -an implementation without writing an abstract syntax tree renderer. - -This document is generated from a text file, `spec.txt`, written -in Markdown with a small extension for the side-by-side tests. -The script `spec2md.pl` can be used to turn `spec.txt` into pandoc -Markdown, which can then be converted into other formats. - -In the examples, the `→` character is used to represent tabs. - -# Preprocessing - -A [line](#line) <a id="line"></a> -is a sequence of zero or more characters followed by a line -ending (CR, LF, or CRLF) or by the end of -file. - -This spec does not specify an encoding; it thinks of lines as composed -of characters rather than bytes. A conforming parser may be limited -to a certain encoding. - -Tabs in lines are expanded to spaces, with a tab stop of 4 characters: - -. -→foo→baz→→bim -. -<pre><code>foo baz bim -</code></pre> -. - -. - a→a - ὐ→a -. -<pre><code>a a -ὐ a -</code></pre> -. - -Line endings are replaced by newline characters (LF). - -A line containing no characters, or a line containing only spaces (after -tab expansion), is called a [blank line](#blank-line). -<a id="blank-line"></a> - -# Blocks and inlines - -We can think of a document as a sequence of [blocks](#block)<a -id="block"></a>---structural elements like paragraphs, block quotations, -lists, headers, rules, and code blocks. Blocks can contain other -blocks, or they can contain [inline](#inline)<a id="inline"></a> content: -words, spaces, links, emphasized text, images, and inline code. - -## Precedence - -Indicators of block structure always take precedence over indicators -of inline structure. So, for example, the following is a list with -two items, not a list with one item containing a code span: - -. -- `one -- two` -. -<ul> -<li>`one</li> -<li>two`</li> -</ul> -. - -This means that parsing can proceed in two steps: first, the block -structure of the document can be discerned; second, text lines inside -paragraphs, headers, and other block constructs can be parsed for inline -structure. The second step requires information about link reference -definitions that will be available only at the end of the first -step. Note that the first step requires processing lines in sequence, -but the second can be parallelized, since the inline parsing of -one block element does not affect the inline parsing of any other. - -## Container blocks and leaf blocks - -We can divide blocks into two types: -[container blocks](#container-block), <a id="container-block"></a> -which can contain other blocks, and [leaf blocks](#leaf-block), -<a id="leaf-block"></a> which cannot. - -# Leaf blocks - -This section describes the different kinds of leaf block that make up a -Markdown document. - -## Horizontal rules - -A line consisting of 0-3 spaces of indentation, followed by a sequence -of three or more matching `-`, `_`, or `*` characters, each followed -optionally by any number of spaces, forms a [horizontal -rule](#horizontal-rule). <a id="horizontal-rule"></a> - -. -*** ---- -___ -. -<hr /> -<hr /> -<hr /> -. - -Wrong characters: - -. -+++ -. -<p>+++</p> -. - -. -=== -. -<p>===</p> -. - -Not enough characters: - -. --- -** -__ -. -<p>-- -** -__</p> -. - -One to three spaces indent are allowed: - -. - *** - *** - *** -. -<hr /> -<hr /> -<hr /> -. - -Four spaces is too many: - -. - *** -. -<pre><code>*** -</code></pre> -. - -. -Foo - *** -. -<p>Foo -***</p> -. - -More than three characters may be used: - -. -_____________________________________ -. -<hr /> -. - -Spaces are allowed between the characters: - -. - - - - -. -<hr /> -. - -. - ** * ** * ** * ** -. -<hr /> -. - -. -- - - - -. -<hr /> -. - -Spaces are allowed at the end: - -. -- - - - -. -<hr /> -. - -However, no other characters may occur at the end or the -beginning: - -. -_ _ _ _ a - -a------ -. -<p>_ _ _ _ a</p> -<p>a------</p> -. - -It is required that all of the non-space characters be the same. -So, this is not a horizontal rule: - -. - *-* -. -<p><em>-</em></p> -. - -Horizontal rules do not need blank lines before or after: - -. -- foo -*** -- bar -. -<ul> -<li>foo</li> -</ul> -<hr /> -<ul> -<li>bar</li> -</ul> -. - -Horizontal rules can interrupt a paragraph: - -. -Foo -*** -bar -. -<p>Foo</p> -<hr /> -<p>bar</p> -. - -Note, however, that this is a setext header, not a paragraph followed -by a horizontal rule: - -. -Foo ---- -bar -. -<h2>Foo</h2> -<p>bar</p> -. - -When both a horizontal rule and a list item are possible -interpretations of a line, the horizontal rule is preferred: - -. -* Foo -* * * -* Bar -. -<ul> -<li>Foo</li> -</ul> -<hr /> -<ul> -<li>Bar</li> -</ul> -. - -If you want a horizontal rule in a list item, use a different bullet: - -. -- Foo -- * * * -. -<ul> -<li>Foo</li> -<li><hr /></li> -</ul> -. - -## ATX headers - -An [ATX header](#atx-header) <a id="atx-header"></a> -consists of a string of characters, parsed as inline content, between an -opening sequence of 1--6 unescaped `#` characters and an optional -closing sequence of any number of `#` characters. The opening sequence -of `#` characters cannot be followed directly by a nonspace character. -The closing `#` characters may be followed by spaces only. The opening -`#` character may be indented 0-3 spaces. The raw contents of the -header are stripped of leading and trailing spaces before being parsed -as inline content. The header level is equal to the number of `#` -characters in the opening sequence. - -Simple headers: - -. -# foo -## foo -### foo -#### foo -##### foo -###### foo -. -<h1>foo</h1> -<h2>foo</h2> -<h3>foo</h3> -<h4>foo</h4> -<h5>foo</h5> -<h6>foo</h6> -. - -More than six `#` characters is not a header: - -. -####### foo -. -<p>####### foo</p> -. - -A space is required between the `#` characters and the header's -contents. Note that many implementations currently do not require -the space. However, the space was required by the [original ATX -implementation](https://www.aaronsw.com/2002/atx/atx.py), and it helps -prevent things like the following from being parsed as headers: - -. -#5 bolt -. -<p>#5 bolt</p> -. - -This is not a header, because the first `#` is escaped: - -. -\## foo -. -<p>## foo</p> -. - -Contents are parsed as inlines: - -. -# foo *bar* \*baz\* -. -<h1>foo <em>bar</em> *baz*</h1> -. - -Leading and trailing blanks are ignored in parsing inline content: - -. -# foo -. -<h1>foo</h1> -. - -One to three spaces indentation are allowed: - -. - ### foo - ## foo - # foo -. -<h3>foo</h3> -<h2>foo</h2> -<h1>foo</h1> -. - -Four spaces are too much: - -. - # foo -. -<pre><code># foo -</code></pre> -. - -. -foo - # bar -. -<p>foo -# bar</p> -. - -A closing sequence of `#` characters is optional: - -. -## foo ## - ### bar ### -. -<h2>foo</h2> -<h3>bar</h3> -. - -It need not be the same length as the opening sequence: - -. -# foo ################################## -##### foo ## -. -<h1>foo</h1> -<h5>foo</h5> -. - -Spaces are allowed after the closing sequence: - -. -### foo ### -. -<h3>foo</h3> -. - -A sequence of `#` characters with a nonspace character following it -is not a closing sequence, but counts as part of the contents of the -header: - -. -### foo ### b -. -<h3>foo ### b</h3> -. - -Backslash-escaped `#` characters do not count as part -of the closing sequence: - -. -### foo \### -## foo \#\## -# foo \# -. -<h3>foo #</h3> -<h2>foo ##</h2> -<h1>foo #</h1> -. - -ATX headers need not be separated from surrounding content by blank -lines, and they can interrupt paragraphs: - -. -**** -## foo -**** -. -<hr /> -<h2>foo</h2> -<hr /> -. - -. -Foo bar -# baz -Bar foo -. -<p>Foo bar</p> -<h1>baz</h1> -<p>Bar foo</p> -. - -ATX headers can be empty: - -. -## -# -### ### -. -<h2></h2> -<h1></h1> -<h3></h3> -. - -## Setext headers - -A [setext header](#setext-header) <a id="setext-header"></a> -consists of a line of text, containing at least one nonspace character, -with no more than 3 spaces indentation, followed by a [setext header -underline](#setext-header-underline). A [setext header -underline](#setext-header-underline) <a id="setext-header-underline"></a> -is a sequence of `=` characters or a sequence of `-` characters, with no -more than 3 spaces indentation and any number of trailing -spaces. The header is a level 1 header if `=` characters are used, and -a level 2 header if `-` characters are used. The contents of the header -are the result of parsing the first line as Markdown inline content. - -In general, a setext header need not be preceded or followed by a -blank line. However, it cannot interrupt a paragraph, so when a -setext header comes after a paragraph, a blank line is needed between -them. - -Simple examples: - -. -Foo *bar* -========= - -Foo *bar* ---------- -. -<h1>Foo <em>bar</em></h1> -<h2>Foo <em>bar</em></h2> -. - -The underlining can be any length: - -. -Foo -------------------------- - -Foo -= -. -<h2>Foo</h2> -<h1>Foo</h1> -. - -The header content can be indented up to three spaces, and need -not line up with the underlining: - -. - Foo ---- - - Foo ------ - - Foo - === -. -<h2>Foo</h2> -<h2>Foo</h2> -<h1>Foo</h1> -. - -Four spaces indent is too much: - -. - Foo - --- - - Foo ---- -. -<pre><code>Foo ---- - -Foo -</code></pre> -<hr /> -. - -The setext header underline can be indented up to three spaces, and -may have trailing spaces: - -. -Foo - ---- -. -<h2>Foo</h2> -. - -Four spaces is too much: - -. -Foo - --- -. -<p>Foo ----</p> -. - -The setext header underline cannot contain internal spaces: - -. -Foo -= = - -Foo ---- - -. -<p>Foo -= =</p> -<p>Foo</p> -<hr /> -. - -Trailing spaces in the content line do not cause a line break: - -. -Foo ------ -. -<h2>Foo</h2> -. - -Nor does a backslash at the end: - -. -Foo\ ----- -. -<h2>Foo\</h2> -. - -Since indicators of block structure take precedence over -indicators of inline structure, the following are setext headers: - -. -`Foo ----- -` - -<a title="a lot ---- -of dashes"/> -. -<h2>`Foo</h2> -<p>`</p> -<h2><a title="a lot</h2> -<p>of dashes"/></p> -. - -The setext header underline cannot be a lazy line: - -. -> Foo ---- -. -<blockquote> -<p>Foo</p> -</blockquote> -<hr /> -. - -A setext header cannot interrupt a paragraph: - -. -Foo -Bar ---- - -Foo -Bar -=== -. -<p>Foo -Bar</p> -<hr /> -<p>Foo -Bar -===</p> -. - -But in general a blank line is not required before or after: - -. ---- -Foo ---- -Bar ---- -Baz -. -<hr /> -<h2>Foo</h2> -<h2>Bar</h2> -<p>Baz</p> -. - -Setext headers cannot be empty: - -. - -==== -. -<p>====</p> -. - - -## Indented code blocks - -An [indented code block](#indented-code-block) -<a id="indented-code-block"></a> is composed of one or more -[indented chunks](#indented-chunk) separated by blank lines. -An [indented chunk](#indented-chunk) <a id="indented-chunk"></a> -is a sequence of non-blank lines, each indented four or more -spaces. An indented code block cannot interrupt a paragraph, so -if it occurs before or after a paragraph, there must be an -intervening blank line. The contents of the code block are -the literal contents of the lines, including trailing newlines, -minus four spaces of indentation. An indented code block has no -attributes. - -. - a simple - indented code block -. -<pre><code>a simple - indented code block -</code></pre> -. - -The contents are literal text, and do not get parsed as Markdown: - -. - <a/> - *hi* - - - one -. -<pre><code><a/> -*hi* - -- one -</code></pre> -. - -Here we have three chunks separated by blank lines: - -. - chunk1 - - chunk2 - - - - chunk3 -. -<pre><code>chunk1 - -chunk2 - - - -chunk3 -</code></pre> -. - -Any initial spaces beyond four will be included in the content, even -in interior blank lines: - -. - chunk1 - - chunk2 -. -<pre><code>chunk1 - - chunk2 -</code></pre> -. - -An indented code block cannot interrupt a paragraph. (This -allows hanging indents and the like.) - -. -Foo - bar - -. -<p>Foo -bar</p> -. - -However, any non-blank line with fewer than four leading spaces ends -the code block immediately. So a paragraph may occur immediately -after indented code: - -. - foo -bar -. -<pre><code>foo -</code></pre> -<p>bar</p> -. - -And indented code can occur immediately before and after other kinds of -blocks: - -. -# Header - foo -Header ------- - foo ----- -. -<h1>Header</h1> -<pre><code>foo -</code></pre> -<h2>Header</h2> -<pre><code>foo -</code></pre> -<hr /> -. - -The first line can be indented more than four spaces: - -. - foo - bar -. -<pre><code> foo -bar -</code></pre> -. - -Blank lines preceding or following an indented code block -are not included in it: - -. - - - foo - - -. -<pre><code>foo -</code></pre> -. - -Trailing spaces are included in the code block's content: - -. - foo -. -<pre><code>foo -</code></pre> -. - - -## Fenced code blocks - -A [code fence](#code-fence) <a id="code-fence"></a> is a sequence -of at least three consecutive backtick characters (`` ` ``) or -tildes (`~`). (Tildes and backticks cannot be mixed.) -A [fenced code block](#fenced-code-block) <a id="fenced-code-block"></a> -begins with a code fence, indented no more than three spaces. - -The line with the opening code fence may optionally contain some text -following the code fence; this is trimmed of leading and trailing -spaces and called the [info string](#info-string). -<a id="info-string"></a> The info string may not contain any backtick -characters. (The reason for this restriction is that otherwise -some inline code would be incorrectly interpreted as the -beginning of a fenced code block.) - -The content of the code block consists of all subsequent lines, until -a closing [code fence](#code-fence) of the same type as the code block -began with (backticks or tildes), and with at least as many backticks -or tildes as the opening code fence. If the leading code fence is -indented N spaces, then up to N spaces of indentation are removed from -each line of the content (if present). (If a content line is not -indented, it is preserved unchanged. If it is indented less than N -spaces, all of the indentation is removed.) - -The closing code fence may be indented up to three spaces, and may be -followed only by spaces, which are ignored. If the end of the -containing block (or document) is reached and no closing code fence -has been found, the code block contains all of the lines after the -opening code fence until the end of the containing block (or -document). (An alternative spec would require backtracking in the -event that a closing code fence is not found. But this makes parsing -much less efficient, and there seems to be no real down side to the -behavior described here.) - -A fenced code block may interrupt a paragraph, and does not require -a blank line either before or after. - -The content of a code fence is treated as literal text, not parsed -as inlines. The first word of the info string is typically used to -specify the language of the code sample, and rendered in the `class` -attribute of the `code` tag. However, this spec does not mandate any -particular treatment of the info string. - -Here is a simple example with backticks: - -. -``` -< - > -``` -. -<pre><code>< - > -</code></pre> -. - -With tildes: - -. -~~~ -< - > -~~~ -. -<pre><code>< - > -</code></pre> -. - -The closing code fence must use the same character as the opening -fence: - -. -``` -aaa -~~~ -``` -. -<pre><code>aaa -~~~ -</code></pre> -. - -. -~~~ -aaa -``` -~~~ -. -<pre><code>aaa -``` -</code></pre> -. - -The closing code fence must be at least as long as the opening fence: - -. -```` -aaa -``` -`````` -. -<pre><code>aaa -``` -</code></pre> -. - -. -~~~~ -aaa -~~~ -~~~~ -. -<pre><code>aaa -~~~ -</code></pre> -. - -Unclosed code blocks are closed by the end of the document: - -. -``` -. -<pre><code></code></pre> -. - -. -````` - -``` -aaa -. -<pre><code> -``` -aaa -</code></pre> -. - -A code block can have all empty lines as its content: - -. -``` - - -``` -. -<pre><code> - -</code></pre> -. - -A code block can be empty: - -. -``` -``` -. -<pre><code></code></pre> -. - -Fences can be indented. If the opening fence is indented, -content lines will have equivalent opening indentation removed, -if present: - -. - ``` - aaa -aaa -``` -. -<pre><code>aaa -aaa -</code></pre> -. - -. - ``` -aaa - aaa -aaa - ``` -. -<pre><code>aaa -aaa -aaa -</code></pre> -. - -. - ``` - aaa - aaa - aaa - ``` -. -<pre><code>aaa - aaa -aaa -</code></pre> -. - -Four spaces indentation produces an indented code block: - -. - ``` - aaa - ``` -. -<pre><code>``` -aaa -``` -</code></pre> -. - -Code fences (opening and closing) cannot contain internal spaces: - -. -``` ``` -aaa -. -<p><code></code> -aaa</p> -. - -. -~~~~~~ -aaa -~~~ ~~ -. -<pre><code>aaa -~~~ ~~ -</code></pre> -. - -Fenced code blocks can interrupt paragraphs, and can be followed -directly by paragraphs, without a blank line between: - -. -foo -``` -bar -``` -baz -. -<p>foo</p> -<pre><code>bar -</code></pre> -<p>baz</p> -. - -Other blocks can also occur before and after fenced code blocks -without an intervening blank line: - -. -foo ---- -~~~ -bar -~~~ -# baz -. -<h2>foo</h2> -<pre><code>bar -</code></pre> -<h1>baz</h1> -. - -An [info string](#info-string) can be provided after the opening code fence. -Opening and closing spaces will be stripped, and the first word, prefixed -with `language-`, is used as the value for the `class` attribute of the -`code` element within the enclosing `pre` element. - -. -```ruby -def foo(x) - return 3 -end -``` -. -<pre><code class="language-ruby">def foo(x) - return 3 -end -</code></pre> -. - -. -~~~~ ruby startline=3 $%@#$ -def foo(x) - return 3 -end -~~~~~~~ -. -<pre><code class="language-ruby">def foo(x) - return 3 -end -</code></pre> -. - -. -````; -```` -. -<pre><code class="language-;"></code></pre> -. - -Info strings for backtick code blocks cannot contain backticks: - -. -``` aa ``` -foo -. -<p><code>aa</code> -foo</p> -. - -Closing code fences cannot have info strings: - -. -``` -``` aaa -``` -. -<pre><code>``` aaa -</code></pre> -. - - -## HTML blocks - -An [HTML block tag](#html-block-tag) <a id="html-block-tag"></a> is -an [open tag](#open-tag) or [closing tag](#closing-tag) whose tag -name is one of the following (case-insensitive): -`article`, `header`, `aside`, `hgroup`, `blockquote`, `hr`, `iframe`, -`body`, `li`, `map`, `button`, `object`, `canvas`, `ol`, `caption`, -`output`, `col`, `p`, `colgroup`, `pre`, `dd`, `progress`, `div`, -`section`, `dl`, `table`, `td`, `dt`, `tbody`, `embed`, `textarea`, -`fieldset`, `tfoot`, `figcaption`, `th`, `figure`, `thead`, `footer`, -`footer`, `tr`, `form`, `ul`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, -`video`, `script`, `style`. - -An [HTML block](#html-block) <a id="html-block"></a> begins with an -[HTML block tag](#html-block-tag), [HTML comment](#html-comment), -[processing instruction](#processing-instruction), -[declaration](#declaration), or [CDATA section](#cdata-section). -It ends when a [blank line](#blank-line) or the end of the -input is encountered. The initial line may be indented up to three -spaces, and subsequent lines may have any indentation. The contents -of the HTML block are interpreted as raw HTML, and will not be escaped -in HTML output. - -Some simple examples: - -. -<table> - <tr> - <td> - hi - </td> - </tr> -</table> - -okay. -. -<table> - <tr> - <td> - hi - </td> - </tr> -</table> -<p>okay.</p> -. - -. - <div> - *hello* - <foo><a> -. - <div> - *hello* - <foo><a> -. - -Here we have two code blocks with a Markdown paragraph between them: - -. -<DIV CLASS="foo"> - -*Markdown* - -</DIV> -. -<DIV CLASS="foo"> -<p><em>Markdown</em></p> -</DIV> -. - -In the following example, what looks like a Markdown code block -is actually part of the HTML block, which continues until a blank -line or the end of the document is reached: - -. -<div></div> -``` c -int x = 33; -``` -. -<div></div> -``` c -int x = 33; -``` -. - -A comment: - -. -<!-- Foo -bar - baz --> -. -<!-- Foo -bar - baz --> -. - -A processing instruction: - -. -<?php - echo 'foo' -?> -. -<?php - echo 'foo' -?> -. - -CDATA: - -. -<![CDATA[ -function matchwo(a,b) -{ -if (a < b && a < 0) then - { - return 1; - } -else - { - return 0; - } -} -]]> -. -<![CDATA[ -function matchwo(a,b) -{ -if (a < b && a < 0) then - { - return 1; - } -else - { - return 0; - } -} -]]> -. - -The opening tag can be indented 1-3 spaces, but not 4: - -. - <!-- foo --> - - <!-- foo --> -. - <!-- foo --> -<pre><code><!-- foo --> -</code></pre> -. - -An HTML block can interrupt a paragraph, and need not be preceded -by a blank line. - -. -Foo -<div> -bar -</div> -. -<p>Foo</p> -<div> -bar -</div> -. - -However, a following blank line is always needed, except at the end of -a document: - -. -<div> -bar -</div> -*foo* -. -<div> -bar -</div> -*foo* -. - -An incomplete HTML block tag may also start an HTML block: - -. -<div class -foo -. -<div class -foo -. - -This rule differs from John Gruber's original Markdown syntax -specification, which says: - -> The only restrictions are that block-level HTML elements — -> e.g. `<div>`, `<table>`, `<pre>`, `<p>`, etc. — must be separated from -> surrounding content by blank lines, and the start and end tags of the -> block should not be indented with tabs or spaces. - -In some ways Gruber's rule is more restrictive than the one given -here: - -- It requires that an HTML block be preceded by a blank line. -- It does not allow the start tag to be indented. -- It requires a matching end tag, which it also does not allow to - be indented. - -Indeed, most Markdown implementations, including some of Gruber's -own perl implementations, do not impose these restrictions. - -There is one respect, however, in which Gruber's rule is more liberal -than the one given here, since it allows blank lines to occur inside -an HTML block. There are two reasons for disallowing them here. -First, it removes the need to parse balanced tags, which is -expensive and can require backtracking from the end of the document -if no matching end tag is found. Second, it provides a very simple -and flexible way of including Markdown content inside HTML tags: -simply separate the Markdown from the HTML using blank lines: - -. -<div> - -*Emphasized* text. - -</div> -. -<div> -<p><em>Emphasized</em> text.</p> -</div> -. - -Compare: - -. -<div> -*Emphasized* text. -</div> -. -<div> -*Emphasized* text. -</div> -. - -Some Markdown implementations have adopted a convention of -interpreting content inside tags as text if the open tag has -the attribute `markdown=1`. The rule given above seems a simpler and -more elegant way of achieving the same expressive power, which is also -much simpler to parse. - -The main potential drawback is that one can no longer paste HTML -blocks into Markdown documents with 100% reliability. However, -*in most cases* this will work fine, because the blank lines in -HTML are usually followed by HTML block tags. For example: - -. -<table> - -<tr> - -<td> -Hi -</td> - -</tr> - -</table> -. -<table> -<tr> -<td> -Hi -</td> -</tr> -</table> -. - -Moreover, blank lines are usually not necessary and can be -deleted. The exception is inside `<pre>` tags; here, one can -replace the blank lines with ` ` entities. - -So there is no important loss of expressive power with the new rule. - -## Link reference definitions - -A [link reference definition](#link-reference-definition) -<a id="link-reference-definition"></a> consists of a [link -label](#link-label), indented up to three spaces, followed -by a colon (`:`), optional blank space (including up to one -newline), a [link destination](#link-destination), optional -blank space (including up to one newline), and an optional [link -title](#link-title), which if it is present must be separated -from the [link destination](#link-destination) by whitespace. -No further non-space characters may occur on the line. - -A [link reference-definition](#link-reference-definition) -does not correspond to a structural element of a document. Instead, it -defines a label which can be used in [reference links](#reference-link) -and reference-style [images](#image) elsewhere in the document. [Link -reference definitions] can come either before or after the links that use -them. - -. -[foo]: /url "title" - -[foo] -. -<p><a href="/url" title="title">foo</a></p> -. - -. - [foo]: - /url - 'the title' - -[foo] -. -<p><a href="/url" title="the title">foo</a></p> -. - -. -[Foo*bar\]]:my_(url) 'title (with parens)' - -[Foo*bar\]] -. -<p><a href="my_(url)" title="title (with parens)">Foo*bar]</a></p> -. - -. -[Foo bar]: -<my url> -'title' - -[Foo bar] -. -<p><a href="my%20url" title="title">Foo bar</a></p> -. - -The title may be omitted: - -. -[foo]: -/url - -[foo] -. -<p><a href="/url">foo</a></p> -. - -The link destination may not be omitted: - -. -[foo]: - -[foo] -. -<p>[foo]:</p> -<p>[foo]</p> -. - -A link can come before its corresponding definition: - -. -[foo] - -[foo]: url -. -<p><a href="url">foo</a></p> -. - -If there are several matching definitions, the first one takes -precedence: - -. -[foo] - -[foo]: first -[foo]: second -. -<p><a href="first">foo</a></p> -. - -As noted in the section on [Links], matching of labels is -case-insensitive (see [matches](#matches)). - -. -[FOO]: /url - -[Foo] -. -<p><a href="/url">Foo</a></p> -. - -. -[ΑΓΩ]: /φου - -[αγω] -. -<p><a href="/%CF%86%CE%BF%CF%85">αγω</a></p> -. - -Here is a link reference definition with no corresponding link. -It contributes nothing to the document. - -. -[foo]: /url -. -. - -This is not a link reference definition, because there are -non-space characters after the title: - -. -[foo]: /url "title" ok -. -<p>[foo]: /url "title" ok</p> -. - -This is not a link reference definition, because it is indented -four spaces: - -. - [foo]: /url "title" - -[foo] -. -<pre><code>[foo]: /url "title" -</code></pre> -<p>[foo]</p> -. - -This is not a link reference definition, because it occurs inside -a code block: - -. -``` -[foo]: /url -``` - -[foo] -. -<pre><code>[foo]: /url -</code></pre> -<p>[foo]</p> -. - -A [link reference definition](#link-reference-definition) cannot -interrupt a paragraph. - -. -Foo -[bar]: /baz - -[bar] -. -<p>Foo -[bar]: /baz</p> -<p>[bar]</p> -. - -However, it can directly follow other block elements, such as headers -and horizontal rules, and it need not be followed by a blank line. - -. -# [Foo] -[foo]: /url -> bar -. -<h1><a href="/url">Foo</a></h1> -<blockquote> -<p>bar</p> -</blockquote> -. - -Several [link references](#link-reference) can occur one after another, -without intervening blank lines. - -. -[foo]: /foo-url "foo" -[bar]: /bar-url - "bar" -[baz]: /baz-url - -[foo], -[bar], -[baz] -. -<p><a href="/foo-url" title="foo">foo</a>, -<a href="/bar-url" title="bar">bar</a>, -<a href="/baz-url">baz</a></p> -. - -[Link reference definitions](#link-reference-definition) can occur -inside block containers, like lists and block quotations. They -affect the entire document, not just the container in which they -are defined: - -. -[foo] - -> [foo]: /url -. -<p><a href="/url">foo</a></p> -<blockquote> -</blockquote> -. - - -## Paragraphs - -A sequence of non-blank lines that cannot be interpreted as other -kinds of blocks forms a [paragraph](#paragraph).<a id="paragraph"></a> -The contents of the paragraph are the result of parsing the -paragraph's raw content as inlines. The paragraph's raw content -is formed by concatenating the lines and removing initial and final -spaces. - -A simple example with two paragraphs: - -. -aaa - -bbb -. -<p>aaa</p> -<p>bbb</p> -. - -Paragraphs can contain multiple lines, but no blank lines: - -. -aaa -bbb - -ccc -ddd -. -<p>aaa -bbb</p> -<p>ccc -ddd</p> -. - -Multiple blank lines between paragraph have no effect: - -. -aaa - - -bbb -. -<p>aaa</p> -<p>bbb</p> -. - -Leading spaces are skipped: - -. - aaa - bbb -. -<p>aaa -bbb</p> -. - -Lines after the first may be indented any amount, since indented -code blocks cannot interrupt paragraphs. - -. -aaa - bbb - ccc -. -<p>aaa -bbb -ccc</p> -. - -However, the first line may be indented at most three spaces, -or an indented code block will be triggered: - -. - aaa -bbb -. -<p>aaa -bbb</p> -. - -. - aaa -bbb -. -<pre><code>aaa -</code></pre> -<p>bbb</p> -. - -Final spaces are stripped before inline parsing, so a paragraph -that ends with two or more spaces will not end with a hard line -break: - -. -aaa -bbb -. -<p>aaa<br /> -bbb</p> -. - -## Blank lines - -[Blank lines](#blank-line) between block-level elements are ignored, -except for the role they play in determining whether a [list](#list) -is [tight](#tight) or [loose](#loose). - -Blank lines at the beginning and end of the document are also ignored. - -. - - -aaa - - -# aaa - - -. -<p>aaa</p> -<h1>aaa</h1> -. - - -# Container blocks - -A [container block](#container-block) is a block that has other -blocks as its contents. There are two basic kinds of container blocks: -[block quotes](#block-quote) and [list items](#list-item). -[Lists](#list) are meta-containers for [list items](#list-item). - -We define the syntax for container blocks recursively. The general -form of the definition is: - -> If X is a sequence of blocks, then the result of -> transforming X in such-and-such a way is a container of type Y -> with these blocks as its content. - -So, we explain what counts as a block quote or list item by explaining -how these can be *generated* from their contents. This should suffice -to define the syntax, although it does not give a recipe for *parsing* -these constructions. (A recipe is provided below in the section entitled -[A parsing strategy](#appendix-a-a-parsing-strategy).) - -## Block quotes - -A [block quote marker](#block-quote-marker) <a id="block-quote-marker"></a> -consists of 0-3 spaces of initial indent, plus (a) the character `>` together -with a following space, or (b) a single character `>` not followed by a space. - -The following rules define [block quotes](#block-quote): -<a id="block-quote"></a> - -1. **Basic case.** If a string of lines *Ls* constitute a sequence - of blocks *Bs*, then the result of appending a [block quote - marker](#block-quote-marker) to the beginning of each line in *Ls* - is a [block quote](#block-quote) containing *Bs*. - -2. **Laziness.** If a string of lines *Ls* constitute a [block - quote](#block-quote) with contents *Bs*, then the result of deleting - the initial [block quote marker](#block-quote-marker) from one or - more lines in which the next non-space character after the [block - quote marker](#block-quote-marker) is [paragraph continuation - text](#paragraph-continuation-text) is a block quote with *Bs* as - its content. <a id="paragraph-continuation-text"></a> - [Paragraph continuation text](#paragraph-continuation-text) is text - that will be parsed as part of the content of a paragraph, but does - not occur at the beginning of the paragraph. - -3. **Consecutiveness.** A document cannot contain two [block - quotes](#block-quote) in a row unless there is a [blank - line](#blank-line) between them. - -Nothing else counts as a [block quote](#block-quote). - -Here is a simple example: - -. -> # Foo -> bar -> baz -. -<blockquote> -<h1>Foo</h1> -<p>bar -baz</p> -</blockquote> -. - -The spaces after the `>` characters can be omitted: - -. -># Foo ->bar -> baz -. -<blockquote> -<h1>Foo</h1> -<p>bar -baz</p> -</blockquote> -. - -The `>` characters can be indented 1-3 spaces: - -. - > # Foo - > bar - > baz -. -<blockquote> -<h1>Foo</h1> -<p>bar -baz</p> -</blockquote> -. - -Four spaces gives us a code block: - -. - > # Foo - > bar - > baz -. -<pre><code>> # Foo -> bar -> baz -</code></pre> -. - -The Laziness clause allows us to omit the `>` before a -paragraph continuation line: - -. -> # Foo -> bar -baz -. -<blockquote> -<h1>Foo</h1> -<p>bar -baz</p> -</blockquote> -. - -A block quote can contain some lazy and some non-lazy -continuation lines: - -. -> bar -baz -> foo -. -<blockquote> -<p>bar -baz -foo</p> -</blockquote> -. - -Laziness only applies to lines that are continuations of -paragraphs. Lines containing characters or indentation that indicate -block structure cannot be lazy. - -. -> foo ---- -. -<blockquote> -<p>foo</p> -</blockquote> -<hr /> -. - -. -> - foo -- bar -. -<blockquote> -<ul> -<li>foo</li> -</ul> -</blockquote> -<ul> -<li>bar</li> -</ul> -. - -. -> foo - bar -. -<blockquote> -<pre><code>foo -</code></pre> -</blockquote> -<pre><code>bar -</code></pre> -. - -. -> ``` -foo -``` -. -<blockquote> -<pre><code></code></pre> -</blockquote> -<p>foo</p> -<pre><code></code></pre> -. - -A block quote can be empty: - -. -> -. -<blockquote> -</blockquote> -. - -. -> -> -> -. -<blockquote> -</blockquote> -. - -A block quote can have initial or final blank lines: - -. -> -> foo -> -. -<blockquote> -<p>foo</p> -</blockquote> -. - -A blank line always separates block quotes: - -. -> foo - -> bar -. -<blockquote> -<p>foo</p> -</blockquote> -<blockquote> -<p>bar</p> -</blockquote> -. - -(Most current Markdown implementations, including John Gruber's -original `Markdown.pl`, will parse this example as a single block quote -with two paragraphs. But it seems better to allow the author to decide -whether two block quotes or one are wanted.) - -Consecutiveness means that if we put these block quotes together, -we get a single block quote: - -. -> foo -> bar -. -<blockquote> -<p>foo -bar</p> -</blockquote> -. - -To get a block quote with two paragraphs, use: - -. -> foo -> -> bar -. -<blockquote> -<p>foo</p> -<p>bar</p> -</blockquote> -. - -Block quotes can interrupt paragraphs: - -. -foo -> bar -. -<p>foo</p> -<blockquote> -<p>bar</p> -</blockquote> -. - -In general, blank lines are not needed before or after block -quotes: - -. -> aaa -*** -> bbb -. -<blockquote> -<p>aaa</p> -</blockquote> -<hr /> -<blockquote> -<p>bbb</p> -</blockquote> -. - -However, because of laziness, a blank line is needed between -a block quote and a following paragraph: - -. -> bar -baz -. -<blockquote> -<p>bar -baz</p> -</blockquote> -. - -. -> bar - -baz -. -<blockquote> -<p>bar</p> -</blockquote> -<p>baz</p> -. - -. -> bar -> -baz -. -<blockquote> -<p>bar</p> -</blockquote> -<p>baz</p> -. - -It is a consequence of the Laziness rule that any number -of initial `>`s may be omitted on a continuation line of a -nested block quote: - -. -> > > foo -bar -. -<blockquote> -<blockquote> -<blockquote> -<p>foo -bar</p> -</blockquote> -</blockquote> -</blockquote> -. - -. ->>> foo -> bar ->>baz -. -<blockquote> -<blockquote> -<blockquote> -<p>foo -bar -baz</p> -</blockquote> -</blockquote> -</blockquote> -. - -When including an indented code block in a block quote, -remember that the [block quote marker](#block-quote-marker) includes -both the `>` and a following space. So *five spaces* are needed after -the `>`: - -. -> code - -> not code -. -<blockquote> -<pre><code>code -</code></pre> -</blockquote> -<blockquote> -<p>not code</p> -</blockquote> -. - - -## List items - -A [list marker](#list-marker) <a id="list-marker"></a> is a -[bullet list marker](#bullet-list-marker) or an [ordered list -marker](#ordered-list-marker). - -A [bullet list marker](#bullet-list-marker) <a id="bullet-list-marker"></a> -is a `-`, `+`, or `*` character. - -An [ordered list marker](#ordered-list-marker) <a id="ordered-list-marker"></a> -is a sequence of one of more digits (`0-9`), followed by either a -`.` character or a `)` character. - -The following rules define [list items](#list-item): - -1. **Basic case.** If a sequence of lines *Ls* constitute a sequence of - blocks *Bs* starting with a non-space character and not separated - from each other by more than one blank line, and *M* is a list - marker *M* of width *W* followed by 0 < *N* < 5 spaces, then the result - of prepending *M* and the following spaces to the first line of - *Ls*, and indenting subsequent lines of *Ls* by *W + N* spaces, is a - list item with *Bs* as its contents. The type of the list item - (bullet or ordered) is determined by the type of its list marker. - If the list item is ordered, then it is also assigned a start - number, based on the ordered list marker. - -For example, let *Ls* be the lines - -. -A paragraph -with two lines. - - indented code - -> A block quote. -. -<p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote> -. - -And let *M* be the marker `1.`, and *N* = 2. Then rule #1 says -that the following is an ordered list item with start number 1, -and the same contents as *Ls*: - -. -1. A paragraph - with two lines. - - indented code - - > A block quote. -. -<ol> -<li><p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote></li> -</ol> -. - -The most important thing to notice is that the position of -the text after the list marker determines how much indentation -is needed in subsequent blocks in the list item. If the list -marker takes up two spaces, and there are three spaces between -the list marker and the next nonspace character, then blocks -must be indented five spaces in order to fall under the list -item. - -Here are some examples showing how far content must be indented to be -put under the list item: - -. -- one - - two -. -<ul> -<li>one</li> -</ul> -<p>two</p> -. - -. -- one - - two -. -<ul> -<li><p>one</p> -<p>two</p></li> -</ul> -. - -. - - one - - two -. -<ul> -<li>one</li> -</ul> -<pre><code> two -</code></pre> -. - -. - - one - - two -. -<ul> -<li><p>one</p> -<p>two</p></li> -</ul> -. - -It is tempting to think of this in terms of columns: the continuation -blocks must be indented at least to the column of the first nonspace -character after the list marker. However, that is not quite right. -The spaces after the list marker determine how much relative indentation -is needed. Which column this indentation reaches will depend on -how the list item is embedded in other constructions, as shown by -this example: - -. - > > 1. one ->> ->> two -. -<blockquote> -<blockquote> -<ol> -<li><p>one</p> -<p>two</p></li> -</ol> -</blockquote> -</blockquote> -. - -Here `two` occurs in the same column as the list marker `1.`, -but is actually contained in the list item, because there is -sufficent indentation after the last containing blockquote marker. - -The converse is also possible. In the following example, the word `two` -occurs far to the right of the initial text of the list item, `one`, but -it is not considered part of the list item, because it is not indented -far enough past the blockquote marker: - -. ->>- one ->> - > > two -. -<blockquote> -<blockquote> -<ul> -<li>one</li> -</ul> -<p>two</p> -</blockquote> -</blockquote> -. - -A list item may not contain blocks that are separated by more than -one blank line. Thus, two blank lines will end a list, unless the -two blanks are contained in a [fenced code block](#fenced-code-block). - -. -- foo - - bar - -- foo - - - bar - -- ``` - foo - - - bar - ``` -. -<ul> -<li><p>foo</p> -<p>bar</p></li> -<li><p>foo</p></li> -</ul> -<p>bar</p> -<ul> -<li><pre><code>foo - - -bar -</code></pre></li> -</ul> -. - -A list item may contain any kind of block: - -. -1. foo - - ``` - bar - ``` - - baz - - > bam -. -<ol> -<li><p>foo</p> -<pre><code>bar -</code></pre> -<p>baz</p> -<blockquote> -<p>bam</p> -</blockquote></li> -</ol> -. - -2. **Item starting with indented code.** If a sequence of lines *Ls* - constitute a sequence of blocks *Bs* starting with an indented code - block and not separated from each other by more than one blank line, - and *M* is a list marker *M* of width *W* followed by - one space, then the result of prepending *M* and the following - space to the first line of *Ls*, and indenting subsequent lines of - *Ls* by *W + 1* spaces, is a list item with *Bs* as its contents. - If a line is empty, then it need not be indented. The type of the - list item (bullet or ordered) is determined by the type of its list - marker. If the list item is ordered, then it is also assigned a - start number, based on the ordered list marker. - -An indented code block will have to be indented four spaces beyond -the edge of the region where text will be included in the list item. -In the following case that is 6 spaces: - -. -- foo - - bar -. -<ul> -<li><p>foo</p> -<pre><code>bar -</code></pre></li> -</ul> -. - -And in this case it is 11 spaces: - -. - 10. foo - - bar -. -<ol start="10"> -<li><p>foo</p> -<pre><code>bar -</code></pre></li> -</ol> -. - -If the *first* block in the list item is an indented code block, -then by rule #2, the contents must be indented *one* space after the -list marker: - -. - indented code - -paragraph - - more code -. -<pre><code>indented code -</code></pre> -<p>paragraph</p> -<pre><code>more code -</code></pre> -. - -. -1. indented code - - paragraph - - more code -. -<ol> -<li><pre><code>indented code -</code></pre> -<p>paragraph</p> -<pre><code>more code -</code></pre></li> -</ol> -. - -Note that an additional space indent is interpreted as space -inside the code block: - -. -1. indented code - - paragraph - - more code -. -<ol> -<li><pre><code> indented code -</code></pre> -<p>paragraph</p> -<pre><code>more code -</code></pre></li> -</ol> -. - -Note that rules #1 and #2 only apply to two cases: (a) cases -in which the lines to be included in a list item begin with a nonspace -character, and (b) cases in which they begin with an indented code -block. In a case like the following, where the first block begins with -a three-space indent, the rules do not allow us to form a list item by -indenting the whole thing and prepending a list marker: - -. - foo - -bar -. -<p>foo</p> -<p>bar</p> -. - -. -- foo - - bar -. -<ul> -<li>foo</li> -</ul> -<p>bar</p> -. - -This is not a significant restriction, because when a block begins -with 1-3 spaces indent, the indentation can always be removed without -a change in interpretation, allowing rule #1 to be applied. So, in -the above case: - -. -- foo - - bar -. -<ul> -<li><p>foo</p> -<p>bar</p></li> -</ul> -. - - -3. **Indentation.** If a sequence of lines *Ls* constitutes a list item - according to rule #1 or #2, then the result of indenting each line - of *L* by 1-3 spaces (the same for each line) also constitutes a - list item with the same contents and attributes. If a line is - empty, then it need not be indented. - -Indented one space: - -. - 1. A paragraph - with two lines. - - indented code - - > A block quote. -. -<ol> -<li><p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote></li> -</ol> -. - -Indented two spaces: - -. - 1. A paragraph - with two lines. - - indented code - - > A block quote. -. -<ol> -<li><p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote></li> -</ol> -. - -Indented three spaces: - -. - 1. A paragraph - with two lines. - - indented code - - > A block quote. -. -<ol> -<li><p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote></li> -</ol> -. - -Four spaces indent gives a code block: - -. - 1. A paragraph - with two lines. - - indented code - - > A block quote. -. -<pre><code>1. A paragraph - with two lines. - - indented code - - > A block quote. -</code></pre> -. - - -4. **Laziness.** If a string of lines *Ls* constitute a [list - item](#list-item) with contents *Bs*, then the result of deleting - some or all of the indentation from one or more lines in which the - next non-space character after the indentation is - [paragraph continuation text](#paragraph-continuation-text) is a - list item with the same contents and attributes. - -Here is an example with lazy continuation lines: - -. - 1. A paragraph -with two lines. - - indented code - - > A block quote. -. -<ol> -<li><p>A paragraph -with two lines.</p> -<pre><code>indented code -</code></pre> -<blockquote> -<p>A block quote.</p> -</blockquote></li> -</ol> -. - -Indentation can be partially deleted: - -. - 1. A paragraph - with two lines. -. -<ol> -<li>A paragraph -with two lines.</li> -</ol> -. - -These examples show how laziness can work in nested structures: - -. -> 1. > Blockquote -continued here. -. -<blockquote> -<ol> -<li><blockquote> -<p>Blockquote -continued here.</p> -</blockquote></li> -</ol> -</blockquote> -. - -. -> 1. > Blockquote -> continued here. -. -<blockquote> -<ol> -<li><blockquote> -<p>Blockquote -continued here.</p> -</blockquote></li> -</ol> -</blockquote> -. - - -5. **That's all.** Nothing that is not counted as a list item by rules - #1--4 counts as a [list item](#list-item). - -The rules for sublists follow from the general rules above. A sublist -must be indented the same number of spaces a paragraph would need to be -in order to be included in the list item. - -So, in this case we need two spaces indent: - -. -- foo - - bar - - baz -. -<ul> -<li>foo -<ul> -<li>bar -<ul> -<li>baz</li> -</ul></li> -</ul></li> -</ul> -. - -One is not enough: - -. -- foo - - bar - - baz -. -<ul> -<li>foo</li> -<li>bar</li> -<li>baz</li> -</ul> -. - -Here we need four, because the list marker is wider: - -. -10) foo - - bar -. -<ol start="10"> -<li>foo -<ul> -<li>bar</li> -</ul></li> -</ol> -. - -Three is not enough: - -. -10) foo - - bar -. -<ol start="10"> -<li>foo</li> -</ol> -<ul> -<li>bar</li> -</ul> -. - -A list may be the first block in a list item: - -. -- - foo -. -<ul> -<li><ul> -<li>foo</li> -</ul></li> -</ul> -. - -. -1. - 2. foo -. -<ol> -<li><ul> -<li><ol start="2"> -<li>foo</li> -</ol></li> -</ul></li> -</ol> -. - -A list item may be empty: - -. -- foo -- -- bar -. -<ul> -<li>foo</li> -<li></li> -<li>bar</li> -</ul> -. - -. -- -. -<ul> -<li></li> -</ul> -. - -### Motivation - -John Gruber's Markdown spec says the following about list items: - -1. "List markers typically start at the left margin, but may be indented - by up to three spaces. List markers must be followed by one or more - spaces or a tab." - -2. "To make lists look nice, you can wrap items with hanging indents.... - But if you don't want to, you don't have to." - -3. "List items may consist of multiple paragraphs. Each subsequent - paragraph in a list item must be indented by either 4 spaces or one - tab." - -4. "It looks nice if you indent every line of the subsequent paragraphs, - but here again, Markdown will allow you to be lazy." - -5. "To put a blockquote within a list item, the blockquote's `>` - delimiters need to be indented." - -6. "To put a code block within a list item, the code block needs to be - indented twice — 8 spaces or two tabs." - -These rules specify that a paragraph under a list item must be indented -four spaces (presumably, from the left margin, rather than the start of -the list marker, but this is not said), and that code under a list item -must be indented eight spaces instead of the usual four. They also say -that a block quote must be indented, but not by how much; however, the -example given has four spaces indentation. Although nothing is said -about other kinds of block-level content, it is certainly reasonable to -infer that *all* block elements under a list item, including other -lists, must be indented four spaces. This principle has been called the -*four-space rule*. - -The four-space rule is clear and principled, and if the reference -implementation `Markdown.pl` had followed it, it probably would have -become the standard. However, `Markdown.pl` allowed paragraphs and -sublists to start with only two spaces indentation, at least on the -outer level. Worse, its behavior was inconsistent: a sublist of an -outer-level list needed two spaces indentation, but a sublist of this -sublist needed three spaces. It is not surprising, then, that different -implementations of Markdown have developed very different rules for -determining what comes under a list item. (Pandoc and python-Markdown, -for example, stuck with Gruber's syntax description and the four-space -rule, while discount, redcarpet, marked, PHP Markdown, and others -followed `Markdown.pl`'s behavior more closely.) - -Unfortunately, given the divergences between implementations, there -is no way to give a spec for list items that will be guaranteed not -to break any existing documents. However, the spec given here should -correctly handle lists formatted with either the four-space rule or -the more forgiving `Markdown.pl` behavior, provided they are laid out -in a way that is natural for a human to read. - -The strategy here is to let the width and indentation of the list marker -determine the indentation necessary for blocks to fall under the list -item, rather than having a fixed and arbitrary number. The writer can -think of the body of the list item as a unit which gets indented to the -right enough to fit the list marker (and any indentation on the list -marker). (The laziness rule, #4, then allows continuation lines to be -unindented if needed.) - -This rule is superior, we claim, to any rule requiring a fixed level of -indentation from the margin. The four-space rule is clear but -unnatural. It is quite unintuitive that - -``` markdown -- foo - - bar - - - baz -``` - -should be parsed as two lists with an intervening paragraph, - -``` html -<ul> -<li>foo</li> -</ul> -<p>bar</p> -<ul> -<li>baz</li> -</ul> -``` - -as the four-space rule demands, rather than a single list, - -``` html -<ul> -<li><p>foo</p> -<p>bar</p> -<ul> -<li>baz</li> -</ul></li> -</ul> -``` - -The choice of four spaces is arbitrary. It can be learned, but it is -not likely to be guessed, and it trips up beginners regularly. - -Would it help to adopt a two-space rule? The problem is that such -a rule, together with the rule allowing 1--3 spaces indentation of the -initial list marker, allows text that is indented *less than* the -original list marker to be included in the list item. For example, -`Markdown.pl` parses - -``` markdown - - one - - two -``` - -as a single list item, with `two` a continuation paragraph: - -``` html -<ul> -<li><p>one</p> -<p>two</p></li> -</ul> -``` - -and similarly - -``` markdown -> - one -> -> two -``` - -as - -``` html -<blockquote> -<ul> -<li><p>one</p> -<p>two</p></li> -</ul> -</blockquote> -``` - -This is extremely unintuitive. - -Rather than requiring a fixed indent from the margin, we could require -a fixed indent (say, two spaces, or even one space) from the list marker (which -may itself be indented). This proposal would remove the last anomaly -discussed. Unlike the spec presented above, it would count the following -as a list item with a subparagraph, even though the paragraph `bar` -is not indented as far as the first paragraph `foo`: - -``` markdown - 10. foo - - bar -``` - -Arguably this text does read like a list item with `bar` as a subparagraph, -which may count in favor of the proposal. However, on this proposal indented -code would have to be indented six spaces after the list marker. And this -would break a lot of existing Markdown, which has the pattern: - -``` markdown -1. foo - - indented code -``` - -where the code is indented eight spaces. The spec above, by contrast, will -parse this text as expected, since the code block's indentation is measured -from the beginning of `foo`. - -The one case that needs special treatment is a list item that *starts* -with indented code. How much indentation is required in that case, since -we don't have a "first paragraph" to measure from? Rule #2 simply stipulates -that in such cases, we require one space indentation from the list marker -(and then the normal four spaces for the indented code). This will match the -four-space rule in cases where the list marker plus its initial indentation -takes four spaces (a common case), but diverge in other cases. - -## Lists - -A [list](#list) <a id="list"></a> is a sequence of one or more -list items [of the same type](#of-the-same-type). The list items -may be separated by single [blank lines](#blank-line), but two -blank lines end all containing lists. - -Two list items are [of the same type](#of-the-same-type) -<a id="of-the-same-type"></a> if they begin with a [list -marker](#list-marker) of the same type. Two list markers are of the -same type if (a) they are bullet list markers using the same character -(`-`, `+`, or `*`) or (b) they are ordered list numbers with the same -delimiter (either `.` or `)`). - -A list is an [ordered list](#ordered-list) <a id="ordered-list"></a> -if its constituent list items begin with -[ordered list markers](#ordered-list-marker), and a [bullet -list](#bullet-list) <a id="bullet-list"></a> if its constituent list -items begin with [bullet list markers](#bullet-list-marker). - -The [start number](#start-number) <a id="start-number"></a> -of an [ordered list](#ordered-list) is determined by the list number of -its initial list item. The numbers of subsequent list items are -disregarded. - -A list is [loose](#loose) if it any of its constituent list items are -separated by blank lines, or if any of its constituent list items -directly contain two block-level elements with a blank line between -them. Otherwise a list is [tight](#tight). (The difference in HTML output -is that paragraphs in a loose with are wrapped in `<p>` tags, while -paragraphs in a tight list are not.) - -Changing the bullet or ordered list delimiter starts a new list: - -. -- foo -- bar -+ baz -. -<ul> -<li>foo</li> -<li>bar</li> -</ul> -<ul> -<li>baz</li> -</ul> -. - -. -1. foo -2. bar -3) baz -. -<ol> -<li>foo</li> -<li>bar</li> -</ol> -<ol start="3"> -<li>baz</li> -</ol> -. - -There can be blank lines between items, but two blank lines end -a list: - -. -- foo - -- bar - - -- baz -. -<ul> -<li><p>foo</p></li> -<li><p>bar</p></li> -</ul> -<ul> -<li>baz</li> -</ul> -. - -As illustrated above in the section on [list items](#list-item), -two blank lines between blocks *within* a list item will also end a -list: - -. -- foo - - - bar -- baz -. -<ul> -<li>foo</li> -</ul> -<p>bar</p> -<ul> -<li>baz</li> -</ul> -. - -Indeed, two blank lines will end *all* containing lists: - -. -- foo - - bar - - baz - - - bim -. -<ul> -<li>foo -<ul> -<li>bar -<ul> -<li>baz</li> -</ul></li> -</ul></li> -</ul> -<pre><code> bim -</code></pre> -. - -Thus, two blank lines can be used to separate consecutive lists of -the same type, or to separate a list from an indented code block -that would otherwise be parsed as a subparagraph of the final list -item: - -. -- foo -- bar - - -- baz -- bim -. -<ul> -<li>foo</li> -<li>bar</li> -</ul> -<ul> -<li>baz</li> -<li>bim</li> -</ul> -. - -. -- foo - - notcode - -- foo - - - code -. -<ul> -<li><p>foo</p> -<p>notcode</p></li> -<li><p>foo</p></li> -</ul> -<pre><code>code -</code></pre> -. - -List items need not be indented to the same level. The following -list items will be treated as items at the same list level, -since none is indented enough to belong to the previous list -item: - -. -- a - - b - - c - - d - - e - - f -- g -. -<ul> -<li>a</li> -<li>b</li> -<li>c</li> -<li>d</li> -<li>e</li> -<li>f</li> -<li>g</li> -</ul> -. - -This is a loose list, because there is a blank line between -two of the list items: - -. -- a -- b - -- c -. -<ul> -<li><p>a</p></li> -<li><p>b</p></li> -<li><p>c</p></li> -</ul> -. - -So is this, with a empty second item: - -. -* a -* - -* c -. -<ul> -<li><p>a</p></li> -<li></li> -<li><p>c</p></li> -</ul> -. - -These are loose lists, even though there is no space between the items, -because one of the items directly contains two block-level elements -with a blank line between them: - -. -- a -- b - - c -- d -. -<ul> -<li><p>a</p></li> -<li><p>b</p> -<p>c</p></li> -<li><p>d</p></li> -</ul> -. - -. -- a -- b - - [ref]: /url -- d -. -<ul> -<li><p>a</p></li> -<li><p>b</p></li> -<li><p>d</p></li> -</ul> -. - -This is a tight list, because the blank lines are in a code block: - -. -- a -- ``` - b - - - ``` -- c -. -<ul> -<li>a</li> -<li><pre><code>b - - -</code></pre></li> -<li>c</li> -</ul> -. - -This is a tight list, because the blank line is between two -paragraphs of a sublist. So the inner list is loose while -the other list is tight: - -. -- a - - b - - c -- d -. -<ul> -<li>a -<ul> -<li><p>b</p> -<p>c</p></li> -</ul></li> -<li>d</li> -</ul> -. - -This is a tight list, because the blank line is inside the -block quote: - -. -* a - > b - > -* c -. -<ul> -<li>a -<blockquote> -<p>b</p> -</blockquote></li> -<li>c</li> -</ul> -. - -This list is tight, because the consecutive block elements -are not separated by blank lines: - -. -- a - > b - ``` - c - ``` -- d -. -<ul> -<li>a -<blockquote> -<p>b</p> -</blockquote> -<pre><code>c -</code></pre></li> -<li>d</li> -</ul> -. - -A single-paragraph list is tight: - -. -- a -. -<ul> -<li>a</li> -</ul> -. - -. -- a - - b -. -<ul> -<li>a -<ul> -<li>b</li> -</ul></li> -</ul> -. - -Here the outer list is loose, the inner list tight: - -. -* foo - * bar - - baz -. -<ul> -<li><p>foo</p> -<ul> -<li>bar</li> -</ul> -<p>baz</p></li> -</ul> -. - -. -- a - - b - - c - -- d - - e - - f -. -<ul> -<li><p>a</p> -<ul> -<li>b</li> -<li>c</li> -</ul></li> -<li><p>d</p> -<ul> -<li>e</li> -<li>f</li> -</ul></li> -</ul> -. - -# Inlines - -Inlines are parsed sequentially from the beginning of the character -stream to the end (left to right, in left-to-right languages). -Thus, for example, in - -. -`hi`lo` -. -<p><code>hi</code>lo`</p> -. - -`hi` is parsed as code, leaving the backtick at the end as a literal -backtick. - -## Backslash escapes - -Any ASCII punctuation character may be backslash-escaped: - -. -\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~ -. -<p>!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~</p> -. - -Backslashes before other characters are treated as literal -backslashes: - -. -\→\A\a\ \3\φ\« -. -<p>\ \A\a\ \3\φ\«</p> -. - -Escaped characters are treated as regular characters and do -not have their usual Markdown meanings: - -. -\*not emphasized* -\<br/> not a tag -\[not a link](/foo) -\`not code` -1\. not a list -\* not a list -\# not a header -\[foo]: /url "not a reference" -. -<p>*not emphasized* -<br/> not a tag -[not a link](/foo) -`not code` -1. not a list -* not a list -# not a header -[foo]: /url "not a reference"</p> -. - -If a backslash is itself escaped, the following character is not: - -. -\\*emphasis* -. -<p>\<em>emphasis</em></p> -. - -A backslash at the end of the line is a hard line break: - -. -foo\ -bar -. -<p>foo<br /> -bar</p> -. - -Backslash escapes do not work in code blocks, code spans, autolinks, or -raw HTML: - -. -`` \[\` `` -. -<p><code>\[\`</code></p> -. - -. - \[\] -. -<pre><code>\[\] -</code></pre> -. - -. -~~~ -\[\] -~~~ -. -<pre><code>\[\] -</code></pre> -. - -. -<https://google.com?find=\*> -. -<p><a href="https://google.com?find=%5C*">https://google.com?find=\*</a></p> -. - -. -<a href="/bar\/)"> -. -<p><a href="/bar\/)"></p> -. - -But they work in all other contexts, including URLs and link titles, -link references, and info strings in [fenced code -blocks](#fenced-code-block): - -. -[foo](/bar\* "ti\*tle") -. -<p><a href="/bar*" title="ti*tle">foo</a></p> -. - -. -[foo] - -[foo]: /bar\* "ti\*tle" -. -<p><a href="/bar*" title="ti*tle">foo</a></p> -. - -. -``` foo\+bar -foo -``` -. -<pre><code class="language-foo+bar">foo -</code></pre> -. - - -## Entities - -With the goal of making this standard as HTML-agnostic as possible, all HTML valid HTML Entities in any -context are recognized as such and converted into their actual values (i.e. the UTF8 characters representing -the entity itself) before they are stored in the AST. - -This allows implementations that target HTML output to trivially escape the entities when generating HTML, -and simplifies the job of implementations targetting other languages, as these will only need to handle the -UTF8 chars and need not be HTML-entity aware. - -[Named entities](#name-entities) <a id="named-entities"></a> consist of `&` -+ any of the valid HTML5 entity names + `;`. The [following document](https://www.whatwg.org/specs/web-apps/current-work/multipage/entities.json) -is used as an authoritative source of the valid entity names and their corresponding codepoints. - -Conforming implementations that target Markdown don't need to generate entities for all the valid -named entities that exist, with the exception of `"` (`"`), `&` (`&`), `<` (`<`) and `>` (`>`), -which always need to be written as entities for security reasons. - -. - & © Æ Ď ¾ ℋ ⅆ ∲ -. -<p> & © Æ Ď ¾ ℋ ⅆ ∲</p> -. - -[Decimal entities](#decimal-entities) <a id="decimal-entities"></a> -consist of `&#` + a string of 1--8 arabic digits + `;`. Again, these entities need to be recognised -and tranformed into their corresponding UTF8 codepoints. Invalid Unicode codepoints will be written -as the "unknown codepoint" character (`0xFFFD`) - -. -# Ӓ Ϡ � -. -<p># Ӓ Ϡ �</p> -. - -[Hexadecimal entities](#hexadecimal-entities) <a id="hexadecimal-entities"></a> -consist of `&#` + either `X` or `x` + a string of 1-8 hexadecimal digits -+ `;`. They will also be parsed and turned into their corresponding UTF8 values in the AST. - -. -" ആ ಫ -. -<p>" ആ ಫ</p> -. - -Here are some nonentities: - -. -  &x; &#; &#x; &ThisIsWayTooLongToBeAnEntityIsntIt; &hi?; -. -<p>&nbsp &x; &#; &#x; &ThisIsWayTooLongToBeAnEntityIsntIt; &hi?;</p> -. - -Although HTML5 does accept some entities without a trailing semicolon -(such as `©`), these are not recognized as entities here, because it makes the grammar too ambiguous: - -. -© -. -<p>&copy</p> -. - -Strings that are not on the list of HTML5 named entities are not recognized as entities either: - -. -&MadeUpEntity; -. -<p>&MadeUpEntity;</p> -. - -Entities are recognized in any context besides code spans or -code blocks, including raw HTML, URLs, [link titles](#link-title), and -[fenced code block](#fenced-code-block) info strings: - -. -<a href="öö.html"> -. -<p><a href="öö.html"></p> -. - -. -[foo](/föö "föö") -. -<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p> -. - -. -[foo] - -[foo]: /föö "föö" -. -<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p> -. - -. -``` föö -foo -``` -. -<pre><code class="language-föö">foo -</code></pre> -. - -Entities are treated as literal text in code spans and code blocks: - -. -`föö` -. -<p><code>f&ouml;&ouml;</code></p> -. - -. - föfö -. -<pre><code>f&ouml;f&ouml; -</code></pre> -. - -## Code span - -A [backtick string](#backtick-string) <a id="backtick-string"></a> -is a string of one or more backtick characters (`` ` ``) that is neither -preceded nor followed by a backtick. - -A code span begins with a backtick string and ends with a backtick -string of equal length. The contents of the code span are the -characters between the two backtick strings, with leading and trailing -spaces and newlines removed, and consecutive spaces and newlines -collapsed to single spaces. - -This is a simple code span: - -. -`foo` -. -<p><code>foo</code></p> -. - -Here two backticks are used, because the code contains a backtick. -This example also illustrates stripping of leading and trailing spaces: - -. -`` foo ` bar `` -. -<p><code>foo ` bar</code></p> -. - -This example shows the motivation for stripping leading and trailing -spaces: - -. -` `` ` -. -<p><code>``</code></p> -. - -Newlines are treated like spaces: - -. -`` -foo -`` -. -<p><code>foo</code></p> -. - -Interior spaces and newlines are collapsed into single spaces, just -as they would be by a browser: - -. -`foo bar - baz` -. -<p><code>foo bar baz</code></p> -. - -Q: Why not just leave the spaces, since browsers will collapse them -anyway? A: Because we might be targeting a non-HTML format, and we -shouldn't rely on HTML-specific rendering assumptions. - -(Existing implementations differ in their treatment of internal -spaces and newlines. Some, including `Markdown.pl` and -`showdown`, convert an internal newline into a `<br />` tag. -But this makes things difficult for those who like to hard-wrap -their paragraphs, since a line break in the midst of a code -span will cause an unintended line break in the output. Others -just leave internal spaces as they are, which is fine if only -HTML is being targeted.) - -. -`foo `` bar` -. -<p><code>foo `` bar</code></p> -. - -Note that backslash escapes do not work in code spans. All backslashes -are treated literally: - -. -`foo\`bar` -. -<p><code>foo\</code>bar`</p> -. - -Backslash escapes are never needed, because one can always choose a -string of *n* backtick characters as delimiters, where the code does -not contain any strings of exactly *n* backtick characters. - -Code span backticks have higher precedence than any other inline -constructs except HTML tags and autolinks. Thus, for example, this is -not parsed as emphasized text, since the second `*` is part of a code -span: - -. -*foo`*` -. -<p>*foo<code>*</code></p> -. - -And this is not parsed as a link: - -. -[not a `link](/foo`) -. -<p>[not a <code>link](/foo</code>)</p> -. - -But this is a link: - -. -<https://foo.bar.`baz>` -. -<p><a href="https://foo.bar.%60baz">https://foo.bar.`baz</a>`</p> -. - -And this is an HTML tag: - -. -<a href="`">` -. -<p><a href="`">`</p> -. - -When a backtick string is not closed by a matching backtick string, -we just have literal backticks: - -. -```foo`` -. -<p>```foo``</p> -. - -. -`foo -. -<p>`foo</p> -. - -## Emphasis and strong emphasis - -John Gruber's original [Markdown syntax -description](https://daringfireball.net/projects/markdown/syntax#em) says: - -> Markdown treats asterisks (`*`) and underscores (`_`) as indicators of -> emphasis. Text wrapped with one `*` or `_` will be wrapped with an HTML -> `<em>` tag; double `*`'s or `_`'s will be wrapped with an HTML `<strong>` -> tag. - -This is enough for most users, but these rules leave much undecided, -especially when it comes to nested emphasis. The original -`Markdown.pl` test suite makes it clear that triple `***` and -`___` delimiters can be used for strong emphasis, and most -implementations have also allowed the following patterns: - -``` markdown -***strong emph*** -***strong** in emph* -***emph* in strong** -**in strong *emph*** -*in emph **strong*** -``` - -The following patterns are less widely supported, but the intent -is clear and they are useful (especially in contexts like bibliography -entries): - -``` markdown -*emph *with emph* in it* -**strong **with strong** in it** -``` - -Many implementations have also restricted intraword emphasis to -the `*` forms, to avoid unwanted emphasis in words containing -internal underscores. (It is best practice to put these in code -spans, but users often do not.) - -``` markdown -internal emphasis: foo*bar*baz -no emphasis: foo_bar_baz -``` - -The following rules capture all of these patterns, while allowing -for efficient parsing strategies that do not backtrack: - -1. A single `*` character [can open emphasis](#can-open-emphasis) - <a id="can-open-emphasis"></a> iff - - (a) it is not part of a sequence of four or more unescaped `*`s, - (b) it is not followed by whitespace, and - (c) either it is not followed by a `*` character or it is - followed immediately by strong emphasis. - -2. A single `_` character [can open emphasis](#can-open-emphasis) iff - - (a) it is not part of a sequence of four or more unescaped `_`s, - (b) it is not followed by whitespace, - (c) it is not preceded by an ASCII alphanumeric character, and - (d) either it is not followed by a `_` character or it is - followed immediately by strong emphasis. - -3. A single `*` character [can close emphasis](#can-close-emphasis) - <a id="can-close-emphasis"></a> iff - - (a) it is not part of a sequence of four or more unescaped `*`s, and - (b) it is not preceded by whitespace. - -4. A single `_` character [can close emphasis](#can-close-emphasis) iff - - (a) it is not part of a sequence of four or more unescaped `_`s, - (b) it is not preceded by whitespace, and - (c) it is not followed by an ASCII alphanumeric character. - -5. A double `**` [can open strong emphasis](#can-open-strong-emphasis) - <a id="can-open-strong-emphasis" ></a> iff - - (a) it is not part of a sequence of four or more unescaped `*`s, - (b) it is not followed by whitespace, and - (c) either it is not followed by a `*` character or it is - followed immediately by emphasis. - -6. A double `__` [can open strong emphasis](#can-open-strong-emphasis) - iff - - (a) it is not part of a sequence of four or more unescaped `_`s, - (b) it is not followed by whitespace, and - (c) it is not preceded by an ASCII alphanumeric character, and - (d) either it is not followed by a `_` character or it is - followed immediately by emphasis. - -7. A double `**` [can close strong emphasis](#can-close-strong-emphasis) - <a id="can-close-strong-emphasis" ></a> iff - - (a) it is not part of a sequence of four or more unescaped `*`s, and - (b) it is not preceded by whitespace. - -8. A double `__` [can close strong emphasis](#can-close-strong-emphasis) - iff - - (a) it is not part of a sequence of four or more unescaped `_`s, - (b) it is not preceded by whitespace, and - (c) it is not followed by an ASCII alphanumeric character. - -9. Emphasis begins with a delimiter that [can open - emphasis](#can-open-emphasis) and includes inlines parsed - sequentially until a delimiter that [can close - emphasis](#can-close-emphasis), and that uses the same - character (`_` or `*`) as the opening delimiter, is reached. - -10. Strong emphasis begins with a delimiter that [can open strong - emphasis](#can-open-strong-emphasis) and includes inlines parsed - sequentially until a delimiter that [can close strong - emphasis](#can-close-strong-emphasis), and that uses the - same character (`_` or `*`) as the opening delimiter, is reached. - -These rules can be illustrated through a series of examples. - -Simple emphasis: - -. -*foo bar* -. -<p><em>foo bar</em></p> -. - -. -_foo bar_ -. -<p><em>foo bar</em></p> -. - -Simple strong emphasis: - -. -**foo bar** -. -<p><strong>foo bar</strong></p> -. - -. -__foo bar__ -. -<p><strong>foo bar</strong></p> -. - -Emphasis can continue over line breaks: - -. -*foo -bar* -. -<p><em>foo -bar</em></p> -. - -. -_foo -bar_ -. -<p><em>foo -bar</em></p> -. - -. -**foo -bar** -. -<p><strong>foo -bar</strong></p> -. - -. -__foo -bar__ -. -<p><strong>foo -bar</strong></p> -. - -Emphasis can contain other inline constructs: - -. -*foo [bar](/url)* -. -<p><em>foo <a href="/url">bar</a></em></p> -. - -. -_foo [bar](/url)_ -. -<p><em>foo <a href="/url">bar</a></em></p> -. - -. -**foo [bar](/url)** -. -<p><strong>foo <a href="/url">bar</a></strong></p> -. - -. -__foo [bar](/url)__ -. -<p><strong>foo <a href="/url">bar</a></strong></p> -. - -Symbols contained in other inline constructs will not -close emphasis: - -. -*foo [bar*](/url) -. -<p>*foo <a href="/url">bar*</a></p> -. - -. -_foo [bar_](/url) -. -<p>_foo <a href="/url">bar_</a></p> -. - -. -**<a href="**"> -. -<p>**<a href="**"></p> -. - -. -__<a href="__"> -. -<p>__<a href="__"></p> -. - -. -*a `*`* -. -<p><em>a <code>*</code></em></p> -. - -. -_a `_`_ -. -<p><em>a <code>_</code></em></p> -. - -. -**a<https://foo.bar?q=**> -. -<p>**a<a href="https://foo.bar?q=**">https://foo.bar?q=**</a></p> -. - -. -__a<https://foo.bar?q=__> -. -<p>__a<a href="https://foo.bar?q=__">https://foo.bar?q=__</a></p> -. - -This is not emphasis, because the opening delimiter is -followed by white space: - -. -and * foo bar* -. -<p>and * foo bar*</p> -. - -. -_ foo bar_ -. -<p>_ foo bar_</p> -. - -. -and ** foo bar** -. -<p>and ** foo bar**</p> -. - -. -__ foo bar__ -. -<p>__ foo bar__</p> -. - -This is not emphasis, because the closing delimiter is -preceded by white space: - -. -and *foo bar * -. -<p>and *foo bar *</p> -. - -. -and _foo bar _ -. -<p>and _foo bar _</p> -. - -. -and **foo bar ** -. -<p>and **foo bar **</p> -. - -. -and __foo bar __ -. -<p>and __foo bar __</p> -. - -The rules imply that a sequence of four or more unescaped `*` or -`_` characters will always be parsed as a literal string: - -. -****hi**** -. -<p>****hi****</p> -. - -. -_____hi_____ -. -<p>_____hi_____</p> -. - -. -Sign here: _________ -. -<p>Sign here: _________</p> -. - -The rules also imply that there can be no empty emphasis or strong -emphasis: - -. -** is not an empty emphasis -. -<p>** is not an empty emphasis</p> -. - -. -**** is not an empty strong emphasis -. -<p>**** is not an empty strong emphasis</p> -. - -To include `*` or `_` in emphasized sections, use backslash escapes -or code spans: - -. -*here is a \** -. -<p><em>here is a *</em></p> -. - -. -__this is a double underscore (`__`)__ -. -<p><strong>this is a double underscore (<code>__</code>)</strong></p> -. - -`*` delimiters allow intra-word emphasis; `_` delimiters do not: - -. -foo*bar*baz -. -<p>foo<em>bar</em>baz</p> -. - -. -foo_bar_baz -. -<p>foo_bar_baz</p> -. - -. -foo__bar__baz -. -<p>foo__bar__baz</p> -. - -. -_foo_bar_baz_ -. -<p><em>foo_bar_baz</em></p> -. - -. -11*15*32 -. -<p>11<em>15</em>32</p> -. - -. -11_15_32 -. -<p>11_15_32</p> -. - -Internal underscores will be ignored in underscore-delimited -emphasis: - -. -_foo_bar_baz_ -. -<p><em>foo_bar_baz</em></p> -. - -. -__foo__bar__baz__ -. -<p><strong>foo__bar__baz</strong></p> -. - -The rules are sufficient for the following nesting patterns: - -. -***foo bar*** -. -<p><strong><em>foo bar</em></strong></p> -. - -. -___foo bar___ -. -<p><strong><em>foo bar</em></strong></p> -. - -. -***foo** bar* -. -<p><em><strong>foo</strong> bar</em></p> -. - -. -___foo__ bar_ -. -<p><em><strong>foo</strong> bar</em></p> -. - -. -***foo* bar** -. -<p><strong><em>foo</em> bar</strong></p> -. - -. -___foo_ bar__ -. -<p><strong><em>foo</em> bar</strong></p> -. - -. -*foo **bar*** -. -<p><em>foo <strong>bar</strong></em></p> -. - -. -_foo __bar___ -. -<p><em>foo <strong>bar</strong></em></p> -. - -. -**foo *bar*** -. -<p><strong>foo <em>bar</em></strong></p> -. - -. -__foo _bar___ -. -<p><strong>foo <em>bar</em></strong></p> -. - -. -*foo **bar*** -. -<p><em>foo <strong>bar</strong></em></p> -. - -. -_foo __bar___ -. -<p><em>foo <strong>bar</strong></em></p> -. - -. -*foo *bar* baz* -. -<p><em>foo <em>bar</em> baz</em></p> -. - -. -_foo _bar_ baz_ -. -<p><em>foo <em>bar</em> baz</em></p> -. - -. -**foo **bar** baz** -. -<p><strong>foo <strong>bar</strong> baz</strong></p> -. - -. -__foo __bar__ baz__ -. -<p><strong>foo <strong>bar</strong> baz</strong></p> -. - -. -*foo **bar** baz* -. -<p><em>foo <strong>bar</strong> baz</em></p> -. - -. -_foo __bar__ baz_ -. -<p><em>foo <strong>bar</strong> baz</em></p> -. - -. -**foo *bar* baz** -. -<p><strong>foo <em>bar</em> baz</strong></p> -. - -. -__foo _bar_ baz__ -. -<p><strong>foo <em>bar</em> baz</strong></p> -. - -Note that you cannot nest emphasis directly inside emphasis -using the same delimeter, or strong emphasis directly inside -strong emphasis: - -. -**foo** -. -<p><strong>foo</strong></p> -. - -. -****foo**** -. -<p>****foo****</p> -. - -For these nestings, you need to switch delimiters: - -. -*_foo_* -. -<p><em><em>foo</em></em></p> -. - -. -**__foo__** -. -<p><strong><strong>foo</strong></strong></p> -. - -Note that a `*` followed by a `*` can close emphasis, and -a `**` followed by a `*` can close strong emphasis (and -similarly for `_` and `__`): - -. -*foo** -. -<p><em>foo</em>*</p> -. - -. -*foo *bar** -. -<p><em>foo <em>bar</em></em></p> -. - -. -**foo*** -. -<p><strong>foo</strong>*</p> -. - -. -***foo* bar*** -. -<p><strong><em>foo</em> bar</strong>*</p> -. - -. -***foo** bar*** -. -<p><em><strong>foo</strong> bar</em>**</p> -. - -The following contains no strong emphasis, because the opening -delimiter is closed by the first `*` before `bar`: - -. -*foo**bar*** -. -<p><em>foo</em><em>bar</em>**</p> -. - -However, a string of four or more `****` can never close emphasis: - -. -*foo**** -. -<p>*foo****</p> -. - -Note that there are some asymmetries here: - -. -*foo** - -**foo* -. -<p><em>foo</em>*</p> -<p>**foo*</p> -. - -. -*foo *bar** - -**foo* bar* -. -<p><em>foo <em>bar</em></em></p> -<p>**foo* bar*</p> -. - -More cases with mismatched delimiters: - -. -**foo* bar* -. -<p>**foo* bar*</p> -. - -. -*bar*** -. -<p><em>bar</em>**</p> -. - -. -***foo* -. -<p>***foo*</p> -. - -. -**bar*** -. -<p><strong>bar</strong>*</p> -. - -. -***foo** -. -<p>***foo**</p> -. - -. -***foo *bar* -. -<p>***foo <em>bar</em></p> -. - -## Links - -A link contains a [link label](#link-label) (the visible text), -a [destination](#destination) (the URI that is the link destination), -and optionally a [link title](#link-title). There are two basic kinds -of links in Markdown. In [inline links](#inline-links) the destination -and title are given immediately after the label. In [reference -links](#reference-links) the destination and title are defined elsewhere -in the document. - -A [link label](#link-label) <a id="link-label"></a> consists of - -- an opening `[`, followed by -- zero or more backtick code spans, autolinks, HTML tags, link labels, - backslash-escaped ASCII punctuation characters, or non-`]` characters, - followed by -- a closing `]`. - -These rules are motivated by the following intuitive ideas: - -- A link label is a container for inline elements. -- The square brackets bind more tightly than emphasis markers, - but less tightly than `<>` or `` ` ``. -- Link labels may contain material in matching square brackets. - -A [link destination](#link-destination) <a id="link-destination"></a> -consists of either - -- a sequence of zero or more characters between an opening `<` and a - closing `>` that contains no line breaks or unescaped `<` or `>` - characters, or - -- a nonempty sequence of characters that does not include - ASCII space or control characters, and includes parentheses - only if (a) they are backslash-escaped or (b) they are part of - a balanced pair of unescaped parentheses that is not itself - inside a balanced pair of unescaped paretheses. - -A [link title](#link-title) <a id="link-title"></a> consists of either - -- a sequence of zero or more characters between straight double-quote - characters (`"`), including a `"` character only if it is - backslash-escaped, or - -- a sequence of zero or more characters between straight single-quote - characters (`'`), including a `'` character only if it is - backslash-escaped, or - -- a sequence of zero or more characters between matching parentheses - (`(...)`), including a `)` character only if it is backslash-escaped. - -An [inline link](#inline-link) <a id="inline-link"></a> -consists of a [link label](#link-label) followed immediately -by a left parenthesis `(`, optional whitespace, -an optional [link destination](#link-destination), -an optional [link title](#link-title) separated from the link -destination by whitespace, optional whitespace, and a right -parenthesis `)`. The link's text consists of the label (excluding -the enclosing square brackets) parsed as inlines. The link's -URI consists of the link destination, excluding enclosing `<...>` if -present, with backslash-escapes in effect as described above. The -link's title consists of the link title, excluding its enclosing -delimiters, with backslash-escapes in effect as described above. - -Here is a simple inline link: - -. -[link](/uri "title") -. -<p><a href="/uri" title="title">link</a></p> -. - -The title may be omitted: - -. -[link](/uri) -. -<p><a href="/uri">link</a></p> -. - -Both the title and the destination may be omitted: - -. -[link]() -. -<p><a href="">link</a></p> -. - -. -[link](<>) -. -<p><a href="">link</a></p> -. - - -If the destination contains spaces, it must be enclosed in pointy -braces: - -. -[link](/my uri) -. -<p>[link](/my uri)</p> -. - -. -[link](</my uri>) -. -<p><a href="/my%20uri">link</a></p> -. - -The destination cannot contain line breaks, even with pointy braces: - -. -[link](foo -bar) -. -<p>[link](foo -bar)</p> -. - -One level of balanced parentheses is allowed without escaping: - -. -[link]((foo)and(bar)) -. -<p><a href="(foo)and(bar)">link</a></p> -. - -However, if you have parentheses within parentheses, you need to escape -or use the `<...>` form: - -. -[link](foo(and(bar))) -. -<p>[link](foo(and(bar)))</p> -. - -. -[link](foo(and\(bar\))) -. -<p><a href="foo(and(bar))">link</a></p> -. - -. -[link](<foo(and(bar))>) -. -<p><a href="foo(and(bar))">link</a></p> -. - -Parentheses and other symbols can also be escaped, as usual -in Markdown: - -. -[link](foo\)\:) -. -<p><a href="foo):">link</a></p> -. - -URL-escaping and should be left alone inside the destination, as all URL-escaped characters -are also valid URL characters. HTML entities in the destination will be parsed into their UTF8 -codepoints, as usual, and optionally URL-escaped when written as HTML. - -. -[link](foo%20bä) -. -<p><a href="foo%20b%C3%A4">link</a></p> -. - -Note that, because titles can often be parsed as destinations, -if you try to omit the destination and keep the title, you'll -get unexpected results: - -. -[link]("title") -. -<p><a href="%22title%22">link</a></p> -. - -Titles may be in single quotes, double quotes, or parentheses: - -. -[link](/url "title") -[link](/url 'title') -[link](/url (title)) -. -<p><a href="/url" title="title">link</a> -<a href="/url" title="title">link</a> -<a href="/url" title="title">link</a></p> -. - -Backslash escapes and entities may be used in titles: - -. -[link](/url "title \""") -. -<p><a href="/url" title="title """>link</a></p> -. - -Nested balanced quotes are not allowed without escaping: - -. -[link](/url "title "and" title") -. -<p>[link](/url "title "and" title")</p> -. - -But it is easy to work around this by using a different quote type: - -. -[link](/url 'title "and" title') -. -<p><a href="/url" title="title "and" title">link</a></p> -. - -(Note: `Markdown.pl` did allow double quotes inside a double-quoted -title, and its test suite included a test demonstrating this. -But it is hard to see a good rationale for the extra complexity this -brings, since there are already many ways---backslash escaping, -entities, or using a different quote type for the enclosing title---to -write titles containing double quotes. `Markdown.pl`'s handling of -titles has a number of other strange features. For example, it allows -single-quoted titles in inline links, but not reference links. And, in -reference links but not inline links, it allows a title to begin with -`"` and end with `)`. `Markdown.pl` 1.0.1 even allows titles with no closing -quotation mark, though 1.0.2b8 does not. It seems preferable to adopt -a simple, rational rule that works the same way in inline links and -link reference definitions.) - -Whitespace is allowed around the destination and title: - -. -[link]( /uri - "title" ) -. -<p><a href="/uri" title="title">link</a></p> -. - -But it is not allowed between the link label and the -following parenthesis: - -. -[link] (/uri) -. -<p>[link] (/uri)</p> -. - -Note that this is not a link, because the closing `]` occurs in -an HTML tag: - -. -[foo <bar attr="](baz)"> -. -<p>[foo <bar attr="](baz)"></p> -. - - -There are three kinds of [reference links](#reference-link): -<a id="reference-link"></a> - -A [full reference link](#full-reference-link) <a id="full-reference-link"></a> -consists of a [link label](#link-label), optional whitespace, and -another [link label](#link-label) that [matches](#matches) a -[link reference definition](#link-reference-definition) elsewhere in the -document. - -One label [matches](#matches) <a id="matches"></a> -another just in case their normalized forms are equal. To normalize a -label, perform the *unicode case fold* and collapse consecutive internal -whitespace to a single space. If there are multiple matching reference -link definitions, the one that comes first in the document is used. (It -is desirable in such cases to emit a warning.) - -The contents of the first link label are parsed as inlines, which are -used as the link's text. The link's URI and title are provided by the -matching [link reference definition](#link-reference-definition). - -Here is a simple example: - -. -[foo][bar] - -[bar]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -The first label can contain inline content: - -. -[*foo\!*][bar] - -[bar]: /url "title" -. -<p><a href="/url" title="title"><em>foo!</em></a></p> -. - -Matching is case-insensitive: - -. -[foo][BaR] - -[bar]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -Unicode case fold is used: - -. -[Толпой][Толпой] is a Russian word. - -[ТОЛПОЙ]: /url -. -<p><a href="/url">Толпой</a> is a Russian word.</p> -. - -Consecutive internal whitespace is treated as one space for -purposes of determining matching: - -. -[Foo - bar]: /url - -[Baz][Foo bar] -. -<p><a href="/url">Baz</a></p> -. - -There can be whitespace between the two labels: - -. -[foo] [bar] - -[bar]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -. -[foo] -[bar] - -[bar]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -When there are multiple matching [link reference -definitions](#link-reference-definition), the first is used: - -. -[foo]: /url1 - -[foo]: /url2 - -[bar][foo] -. -<p><a href="/url1">bar</a></p> -. - -Note that matching is performed on normalized strings, not parsed -inline content. So the following does not match, even though the -labels define equivalent inline content: - -. -[bar][foo\!] - -[foo!]: /url -. -<p>[bar][foo!]</p> -. - -A [collapsed reference link](#collapsed-reference-link) -<a id="collapsed-reference-link"></a> consists of a [link -label](#link-label) that [matches](#matches) a [link reference -definition](#link-reference-definition) elsewhere in the -document, optional whitespace, and the string `[]`. The contents of the -first link label are parsed as inlines, which are used as the link's -text. The link's URI and title are provided by the matching reference -link definition. Thus, `[foo][]` is equivalent to `[foo][foo]`. - -. -[foo][] - -[foo]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -. -[*foo* bar][] - -[*foo* bar]: /url "title" -. -<p><a href="/url" title="title"><em>foo</em> bar</a></p> -. - -The link labels are case-insensitive: - -. -[Foo][] - -[foo]: /url "title" -. -<p><a href="/url" title="title">Foo</a></p> -. - - -As with full reference links, whitespace is allowed -between the two sets of brackets: - -. -[foo] -[] - -[foo]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -A [shortcut reference link](#shortcut-reference-link) -<a id="shortcut-reference-link"></a> consists of a [link -label](#link-label) that [matches](#matches) a [link reference -definition](#link-reference-definition) elsewhere in the -document and is not followed by `[]` or a link label. -The contents of the first link label are parsed as inlines, -which are used as the link's text. the link's URI and title -are provided by the matching link reference definition. -Thus, `[foo]` is equivalent to `[foo][]`. - -. -[foo] - -[foo]: /url "title" -. -<p><a href="/url" title="title">foo</a></p> -. - -. -[*foo* bar] - -[*foo* bar]: /url "title" -. -<p><a href="/url" title="title"><em>foo</em> bar</a></p> -. - -. -[[*foo* bar]] - -[*foo* bar]: /url "title" -. -<p>[<a href="/url" title="title"><em>foo</em> bar</a>]</p> -. - -The link labels are case-insensitive: - -. -[Foo] - -[foo]: /url "title" -. -<p><a href="/url" title="title">Foo</a></p> -. - -If you just want bracketed text, you can backslash-escape the -opening bracket to avoid links: - -. -\[foo] - -[foo]: /url "title" -. -<p>[foo]</p> -. - -Note that this is a link, because link labels bind more tightly -than emphasis: - -. -[foo*]: /url - -*[foo*] -. -<p>*<a href="/url">foo*</a></p> -. - -However, this is not, because link labels bind less -tightly than code backticks: - -. -[foo`]: /url - -[foo`]` -. -<p>[foo<code>]</code></p> -. - -Link labels can contain matched square brackets: - -. -[[[foo]]] - -[[[foo]]]: /url -. -<p><a href="/url">[[foo]]</a></p> -. - -. -[[[foo]]] - -[[[foo]]]: /url1 -[foo]: /url2 -. -<p><a href="/url1">[[foo]]</a></p> -. - -For non-matching brackets, use backslash escapes: - -. -[\[foo] - -[\[foo]: /url -. -<p><a href="/url">[foo</a></p> -. - -Full references take precedence over shortcut references: - -. -[foo][bar] - -[foo]: /url1 -[bar]: /url2 -. -<p><a href="/url2">foo</a></p> -. - -In the following case `[bar][baz]` is parsed as a reference, -`[foo]` as normal text: - -. -[foo][bar][baz] - -[baz]: /url -. -<p>[foo]<a href="/url">bar</a></p> -. - -Here, though, `[foo][bar]` is parsed as a reference, since -`[bar]` is defined: - -. -[foo][bar][baz] - -[baz]: /url1 -[bar]: /url2 -. -<p><a href="/url2">foo</a><a href="/url1">baz</a></p> -. - -Here `[foo]` is not parsed as a shortcut reference, because it -is followed by a link label (even though `[bar]` is not defined): - -. -[foo][bar][baz] - -[baz]: /url1 -[foo]: /url2 -. -<p>[foo]<a href="/url1">bar</a></p> -. - - -## Images - -An (unescaped) exclamation mark (`!`) followed by a reference or -inline link will be parsed as an image. The link label will be -used as the image's alt text, and the link title, if any, will -be used as the image's title. - -. - -. -<p><img src="/url" alt="foo" title="title" /></p> -. - -. -![foo *bar*] - -[foo *bar*]: train.jpg "train & tracks" -. -<p><img src="train.jpg" alt="foo <em>bar</em>" title="train & tracks" /></p> -. - -. -![foo *bar*][] - -[foo *bar*]: train.jpg "train & tracks" -. -<p><img src="train.jpg" alt="foo <em>bar</em>" title="train & tracks" /></p> -. - -. -![foo *bar*][foobar] - -[FOOBAR]: train.jpg "train & tracks" -. -<p><img src="train.jpg" alt="foo <em>bar</em>" title="train & tracks" /></p> -. - -. - -. -<p><img src="train.jpg" alt="foo" /></p> -. - -. -My  -. -<p>My <img src="/path/to/train.jpg" alt="foo bar" title="title" /></p> -. - -. - -. -<p><img src="url" alt="foo" /></p> -. - -. - -. -<p><img src="/url" alt="" /></p> -. - -Reference-style: - -. -![foo] [bar] - -[bar]: /url -. -<p><img src="/url" alt="foo" /></p> -. - -. -![foo] [bar] - -[BAR]: /url -. -<p><img src="/url" alt="foo" /></p> -. - -Collapsed: - -. -![foo][] - -[foo]: /url "title" -. -<p><img src="/url" alt="foo" title="title" /></p> -. - -. -![*foo* bar][] - -[*foo* bar]: /url "title" -. -<p><img src="/url" alt="<em>foo</em> bar" title="title" /></p> -. - -The labels are case-insensitive: - -. -![Foo][] - -[foo]: /url "title" -. -<p><img src="/url" alt="Foo" title="title" /></p> -. - -As with full reference links, whitespace is allowed -between the two sets of brackets: - -. -![foo] -[] - -[foo]: /url "title" -. -<p><img src="/url" alt="foo" title="title" /></p> -. - -Shortcut: - -. -![foo] - -[foo]: /url "title" -. -<p><img src="/url" alt="foo" title="title" /></p> -. - -. -![*foo* bar] - -[*foo* bar]: /url "title" -. -<p><img src="/url" alt="<em>foo</em> bar" title="title" /></p> -. - -. -![[foo]] - -[[foo]]: /url "title" -. -<p><img src="/url" alt="[foo]" title="title" /></p> -. - -The link labels are case-insensitive: - -. -![Foo] - -[foo]: /url "title" -. -<p><img src="/url" alt="Foo" title="title" /></p> -. - -If you just want bracketed text, you can backslash-escape the -opening `!` and `[`: - -. -\!\[foo] - -[foo]: /url "title" -. -<p>![foo]</p> -. - -If you want a link after a literal `!`, backslash-escape the -`!`: - -. -\![foo] - -[foo]: /url "title" -. -<p>!<a href="/url" title="title">foo</a></p> -. - -## Autolinks - -Autolinks are absolute URIs and email addresses inside `<` and `>`. -They are parsed as links, with the URL or email address as the link -label. - -A [URI autolink](#uri-autolink) <a id="uri-autolink"></a> -consists of `<`, followed by an [absolute -URI](#absolute-uri) not containing `<`, followed by `>`. It is parsed -as a link to the URI, with the URI as the link's label. - -An [absolute URI](#absolute-uri), <a id="absolute-uri"></a> -for these purposes, consists of a [scheme](#scheme) followed by a colon (`:`) -followed by zero or more characters other than ASCII whitespace and -control characters, `<`, and `>`. If the URI includes these characters, -you must use percent-encoding (e.g. `%20` for a space). - -The following [schemes](#scheme) <a id="scheme"></a> -are recognized (case-insensitive): -`coap`, `doi`, `javascript`, `aaa`, `aaas`, `about`, `acap`, `cap`, -`cid`, `crid`, `data`, `dav`, `dict`, `dns`, `file`, `ftp`, `geo`, `go`, -`gopher`, `h323`, `http`, `https`, `iax`, `icap`, `im`, `imap`, `info`, -`ipp`, `iris`, `iris.beep`, `iris.xpc`, `iris.xpcs`, `iris.lwz`, `ldap`, -`mailto`, `mid`, `msrp`, `msrps`, `mtqp`, `mupdate`, `news`, `nfs`, -`ni`, `nih`, `nntp`, `opaquelocktoken`, `pop`, `pres`, `rtsp`, -`service`, `session`, `shttp`, `sieve`, `sip`, `sips`, `sms`, `snmp`,` -soap.beep`, `soap.beeps`, `tag`, `tel`, `telnet`, `tftp`, `thismessage`, -`tn3270`, `tip`, `tv`, `urn`, `vemmi`, `ws`, `wss`, `xcon`, -`xcon-userid`, `xmlrpc.beep`, `xmlrpc.beeps`, `xmpp`, `z39.50r`, -`z39.50s`, `adiumxtra`, `afp`, `afs`, `aim`, `apt`,` attachment`, `aw`, -`beshare`, `bitcoin`, `bolo`, `callto`, `chrome`,` chrome-extension`, -`com-eventbrite-attendee`, `content`, `cvs`,` dlna-playsingle`, -`dlna-playcontainer`, `dtn`, `dvb`, `ed2k`, `facetime`, `feed`, -`finger`, `fish`, `gg`, `git`, `gizmoproject`, `gtalk`, `hcp`, `icon`, -`ipn`, `irc`, `irc6`, `ircs`, `itms`, `jar`, `jms`, `keyparc`, `lastfm`, -`ldaps`, `magnet`, `maps`, `market`,` message`, `mms`, `ms-help`, -`msnim`, `mumble`, `mvn`, `notes`, `oid`, `palm`, `paparazzi`, -`platform`, `proxy`, `psyc`, `query`, `res`, `resource`, `rmi`, `rsync`, -`rtmp`, `secondlife`, `sftp`, `sgn`, `skype`, `smb`, `soldat`, -`spotify`, `ssh`, `steam`, `svn`, `teamspeak`, `things`, `udp`, -`unreal`, `ut2004`, `ventrilo`, `view-source`, `webcal`, `wtai`, -`wyciwyg`, `xfire`, `xri`, `ymsgr`. - -Here are some valid autolinks: - -. -<https://foo.bar.baz> -. -<p><a href="https://foo.bar.baz">https://foo.bar.baz</a></p> -. - -. -<https://foo.bar.baz?q=hello&id=22&boolean> -. -<p><a href="https://foo.bar.baz?q=hello&id=22&boolean">https://foo.bar.baz?q=hello&id=22&boolean</a></p> -. - -. -<irc://foo.bar:2233/baz> -. -<p><a href="irc://foo.bar:2233/baz">irc://foo.bar:2233/baz</a></p> -. - -Uppercase is also fine: - -. -<MAILTO:FOO@BAR.BAZ> -. -<p><a href="MAILTO:FOO@BAR.BAZ">MAILTO:FOO@BAR.BAZ</a></p> -. - -Spaces are not allowed in autolinks: - -. -<https://foo.bar/baz bim> -. -<p><https://foo.bar/baz bim></p> -. - -An [email autolink](#email-autolink) <a id="email-autolink"></a> -consists of `<`, followed by an [email address](#email-address), -followed by `>`. The link's label is the email address, -and the URL is `mailto:` followed by the email address. - -An [email address](#email-address), <a id="email-address"></a> -for these purposes, is anything that matches -the [non-normative regex from the HTML5 -spec](https://www.whatwg.org/specs/web-apps/current-work/multipage/forms.html#e-mail-state-%28type=email%29): - - /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])? - (?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/ - -Examples of email autolinks: - -. -<foo@bar.baz.com> -. -<p><a href="mailto:foo@bar.baz.com">foo@bar.baz.com</a></p> -. - -. -<foo+special@Bar.baz-bar0.com> -. -<p><a href="mailto:foo+special@Bar.baz-bar0.com">foo+special@Bar.baz-bar0.com</a></p> -. - -These are not autolinks: - -. -<> -. -<p><></p> -. - -. -<heck://bing.bong> -. -<p><heck://bing.bong></p> -. - -. -< https://foo.bar > -. -<p>< https://foo.bar ></p> -. - -. -<foo.bar.baz> -. -<p><foo.bar.baz></p> -. - -. -<localhost:5001/foo> -. -<p><localhost:5001/foo></p> -. - -. -https://google.com -. -<p>https://google.com</p> -. - -. -foo@bar.baz.com -. -<p>foo@bar.baz.com</p> -. - -## Raw HTML - -Text between `<` and `>` that looks like an HTML tag is parsed as a -raw HTML tag and will be rendered in HTML without escaping. -Tag and attribute names are not limited to current HTML tags, -so custom tags (and even, say, DocBook tags) may be used. - -Here is the grammar for tags: - -A [tag name](#tag-name) <a id="tag-name"></a> consists of an ASCII letter -followed by zero or more ASCII letters or digits. - -An [attribute](#attribute) <a id="attribute"></a> consists of whitespace, -an **attribute name**, and an optional **attribute value -specification**. - -An [attribute name](#attribute-name) <a id="attribute-name"></a> -consists of an ASCII letter, `_`, or `:`, followed by zero or more ASCII -letters, digits, `_`, `.`, `:`, or `-`. (Note: This is the XML -specification restricted to ASCII. HTML5 is laxer.) - -An [attribute value specification](#attribute-value-specification) -<a id="attribute-value-specification"></a> consists of optional whitespace, -a `=` character, optional whitespace, and an [attribute -value](#attribute-value). - -An [attribute value](#attribute-value) <a id="attribute-value"></a> -consists of an [unquoted attribute value](#unquoted-attribute-value), -a [single-quoted attribute value](#single-quoted-attribute-value), -or a [double-quoted attribute value](#double-quoted-attribute-value). - -An [unquoted attribute value](#unquoted-attribute-value) -<a id="unquoted-attribute-value"></a> is a nonempty string of characters not -including spaces, `"`, `'`, `=`, `<`, `>`, or `` ` ``. - -A [single-quoted attribute value](#single-quoted-attribute-value) -<a id="single-quoted-attribute-value"></a> consists of `'`, zero or more -characters not including `'`, and a final `'`. - -A [double-quoted attribute value](#double-quoted-attribute-value) -<a id="double-quoted-attribute-value"></a> consists of `"`, zero or more -characters not including `"`, and a final `"`. - -An [open tag](#open-tag) <a id="open-tag"></a> consists of a `<` character, -a [tag name](#tag-name), zero or more [attributes](#attribute), -optional whitespace, an optional `/` character, and a `>` character. - -A [closing tag](#closing-tag) <a id="closing-tag"></a> consists of the -string `</`, a [tag name](#tag-name), optional whitespace, and the -character `>`. - -An [HTML comment](#html-comment) <a id="html-comment"></a> consists of the -string `<!--`, a string of characters not including the string `--`, and -the string `-->`. - -A [processing instruction](#processing-instruction) -<a id="processing-instruction"></a> consists of the string `<?`, a string -of characters not including the string `?>`, and the string -`?>`. - -A [declaration](#declaration) <a id="declaration"></a> consists of the -string `<!`, a name consisting of one or more uppercase ASCII letters, -whitespace, a string of characters not including the character `>`, and -the character `>`. - -A [CDATA section](#cdata-section) <a id="cdata-section"></a> consists of -the string `<![CDATA[`, a string of characters not including the string -`]]>`, and the string `]]>`. - -An [HTML tag](#html-tag) <a id="html-tag"></a> consists of an [open -tag](#open-tag), a [closing tag](#closing-tag), an [HTML -comment](#html-comment), a [processing -instruction](#processing-instruction), an [element type -declaration](#element-type-declaration), or a [CDATA -section](#cdata-section). - -Here are some simple open tags: - -. -<a><bab><c2c> -. -<p><a><bab><c2c></p> -. - -Empty elements: - -. -<a/><b2/> -. -<p><a/><b2/></p> -. - -Whitespace is allowed: - -. -<a /><b2 -data="foo" > -. -<p><a /><b2 -data="foo" ></p> -. - -With attributes: - -. -<a foo="bar" bam = 'baz <em>"</em>' -_boolean zoop:33=zoop:33 /> -. -<p><a foo="bar" bam = 'baz <em>"</em>' -_boolean zoop:33=zoop:33 /></p> -. - -Illegal tag names, not parsed as HTML: - -. -<33> <__> -. -<p><33> <__></p> -. - -Illegal attribute names: - -. -<a h*#ref="hi"> -. -<p><a h*#ref="hi"></p> -. - -Illegal attribute values: - -. -<a href="hi'> <a href=hi'> -. -<p><a href="hi'> <a href=hi'></p> -. - -Illegal whitespace: - -. -< a>< -foo><bar/ > -. -<p>< a>< -foo><bar/ ></p> -. - -Missing whitespace: - -. -<a href='bar'title=title> -. -<p><a href='bar'title=title></p> -. - -Closing tags: - -. -</a> -</foo > -. -<p></a> -</foo ></p> -. - -Illegal attributes in closing tag: - -. -</a href="foo"> -. -<p></a href="foo"></p> -. - -Comments: - -. -foo <!-- this is a -comment - with hyphen --> -. -<p>foo <!-- this is a -comment - with hyphen --></p> -. - -. -foo <!-- not a comment -- two hyphens --> -. -<p>foo <!-- not a comment -- two hyphens --></p> -. - -Processing instructions: - -. -foo <?php echo $a; ?> -. -<p>foo <?php echo $a; ?></p> -. - -Declarations: - -. -foo <!ELEMENT br EMPTY> -. -<p>foo <!ELEMENT br EMPTY></p> -. - -CDATA sections: - -. -foo <![CDATA[>&<]]> -. -<p>foo <![CDATA[>&<]]></p> -. - -Entities are preserved in HTML attributes: - -. -<a href="ö"> -. -<p><a href="ö"></p> -. - -Backslash escapes do not work in HTML attributes: - -. -<a href="\*"> -. -<p><a href="\*"></p> -. - -. -<a href="\""> -. -<p><a href="""></p> -. - -## Hard line breaks - -A line break (not in a code span or HTML tag) that is preceded -by two or more spaces is parsed as a linebreak (rendered -in HTML as a `<br />` tag): - -. -foo -baz -. -<p>foo<br /> -baz</p> -. - -For a more visible alternative, a backslash before the newline may be -used instead of two spaces: - -. -foo\ -baz -. -<p>foo<br /> -baz</p> -. - -More than two spaces can be used: - -. -foo -baz -. -<p>foo<br /> -baz</p> -. - -Leading spaces at the beginning of the next line are ignored: - -. -foo - bar -. -<p>foo<br /> -bar</p> -. - -. -foo\ - bar -. -<p>foo<br /> -bar</p> -. - -Line breaks can occur inside emphasis, links, and other constructs -that allow inline content: - -. -*foo -bar* -. -<p><em>foo<br /> -bar</em></p> -. - -. -*foo\ -bar* -. -<p><em>foo<br /> -bar</em></p> -. - -Line breaks do not occur inside code spans - -. -`code -span` -. -<p><code>code span</code></p> -. - -. -`code\ -span` -. -<p><code>code\ span</code></p> -. - -or HTML tags: - -. -<a href="foo -bar"> -. -<p><a href="foo -bar"></p> -. - -. -<a href="foo\ -bar"> -. -<p><a href="foo\ -bar"></p> -. - -## Soft line breaks - -A regular line break (not in a code span or HTML tag) that is not -preceded by two or more spaces is parsed as a softbreak. (A -softbreak may be rendered in HTML either as a newline or as a space. -The result will be the same in browsers. In the examples here, a -newline will be used.) - -. -foo -baz -. -<p>foo -baz</p> -. - -Spaces at the end of the line and beginning of the next line are -removed: - -. -foo - baz -. -<p>foo -baz</p> -. - -A conforming parser may render a soft line break in HTML either as a -line break or as a space. - -A renderer may also provide an option to render soft line breaks -as hard line breaks. - -## Strings - -Any characters not given an interpretation by the above rules will -be parsed as string content. - -. -hello $.;'there -. -<p>hello $.;'there</p> -. - -. -Foo χρῆν -. -<p>Foo χρῆν</p> -. - -Internal spaces are preserved verbatim: - -. -Multiple spaces -. -<p>Multiple spaces</p> -. - -<!-- END TESTS --> - -# Appendix A: A parsing strategy {-} - -## Overview {-} - -Parsing has two phases: - -1. In the first phase, lines of input are consumed and the block -structure of the document---its division into paragraphs, block quotes, -list items, and so on---is constructed. Text is assigned to these -blocks but not parsed. Link reference definitions are parsed and a -map of links is constructed. - -2. In the second phase, the raw text contents of paragraphs and headers -are parsed into sequences of Markdown inline elements (strings, -code spans, links, emphasis, and so on), using the map of link -references constructed in phase 1. - -## The document tree {-} - -At each point in processing, the document is represented as a tree of -**blocks**. The root of the tree is a `document` block. The `document` -may have any number of other blocks as **children**. These children -may, in turn, have other blocks as children. The last child of a block -is normally considered **open**, meaning that subsequent lines of input -can alter its contents. (Blocks that are not open are **closed**.) -Here, for example, is a possible document tree, with the open blocks -marked by arrows: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id" -``` - -## How source lines alter the document tree {-} - -Each line that is processed has an effect on this tree. The line is -analyzed and, depending on its contents, the document may be altered -in one or more of the following ways: - -1. One or more open blocks may be closed. -2. One or more new blocks may be created as children of the - last open block. -3. Text may be added to the last (deepest) open block remaining - on the tree. - -Once a line has been incorporated into the tree in this way, -it can be discarded, so input can be read in a stream. - -We can see how this works by considering how the tree above is -generated by four lines of Markdown: - -``` markdown -> Lorem ipsum dolor -sit amet. -> - Qui *quodsi iracundia* -> - aliquando id -``` - -At the outset, our document model is just - -``` tree --> document -``` - -The first line of our text, - -``` markdown -> Lorem ipsum dolor -``` - -causes a `block_quote` block to be created as a child of our -open `document` block, and a `paragraph` block as a child of -the `block_quote`. Then the text is added to the last open -block, the `paragraph`: - -``` tree --> document - -> block_quote - -> paragraph - "Lorem ipsum dolor" -``` - -The next line, - -``` markdown -sit amet. -``` - -is a "lazy continuation" of the open `paragraph`, so it gets added -to the paragraph's text: - -``` tree --> document - -> block_quote - -> paragraph - "Lorem ipsum dolor\nsit amet." -``` - -The third line, - -``` markdown -> - Qui *quodsi iracundia* -``` - -causes the `paragraph` block to be closed, and a new `list` block -opened as a child of the `block_quote`. A `list_item` is also -added as a child of the `list`, and a `paragraph` as a child of -the `list_item`. The text is then added to the new `paragraph`: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - -> list_item - -> paragraph - "Qui *quodsi iracundia*" -``` - -The fourth line, - -``` markdown -> - aliquando id -``` - -causes the `list_item` (and its child the `paragraph`) to be closed, -and a new `list_item` opened up as child of the `list`. A `paragraph` -is added as a child of the new `list_item`, to contain the text. -We thus obtain the final tree: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id" -``` - -## From block structure to the final document {-} - -Once all of the input has been parsed, all open blocks are closed. - -We then "walk the tree," visiting every node, and parse raw -string contents of paragraphs and headers as inlines. At this -point we have seen all the link reference definitions, so we can -resolve reference links as we go. - -``` tree -document - block_quote - paragraph - str "Lorem ipsum dolor" - softbreak - str "sit amet." - list (type=bullet tight=true bullet_char=-) - list_item - paragraph - str "Qui " - emph - str "quodsi iracundia" - list_item - paragraph - str "aliquando id" -``` - -Notice how the newline in the first paragraph has been parsed as -a `softbreak`, and the asterisks in the first list item have become -an `emph`. - -The document can be rendered as HTML, or in any other format, given -an appropriate renderer. - - diff --git a/core/testdata/packagedocs/referenceLinks.kotlin.md b/core/testdata/packagedocs/referenceLinks.kotlin.md deleted file mode 100644 index f7b1edad..00000000 --- a/core/testdata/packagedocs/referenceLinks.kotlin.md +++ /dev/null @@ -1,6 +0,0 @@ - - -Core functions and types -See [ref](https://example.com) -Also, [example](https://example.com) - diff --git a/core/testdata/packagedocs/referenceLinks.md b/core/testdata/packagedocs/referenceLinks.md deleted file mode 100644 index 177dea0c..00000000 --- a/core/testdata/packagedocs/referenceLinks.md +++ /dev/null @@ -1,17 +0,0 @@ -# Module refLinks - -## Kotlin Standard Library - -The Kotlin standard library is a set of functions and types implementing idiomatic patterns when working with collections, -text and files. -See [ref] -Also, [example][ref] - -# Package kotlin - -Core functions and types -See [ref] -Also, [example][ref] - -<!-- Refs --> -[ref]: https://example.com diff --git a/core/testdata/packagedocs/referenceLinks.module.md b/core/testdata/packagedocs/referenceLinks.module.md deleted file mode 100644 index 08372175..00000000 --- a/core/testdata/packagedocs/referenceLinks.module.md +++ /dev/null @@ -1,9 +0,0 @@ - - -## Kotlin Standard Library - -The Kotlin standard library is a set of functions and types implementing idiomatic patterns when working with collections, -text and files. -See [ref](https://example.com) -Also, [example](https://example.com) - diff --git a/core/testdata/packagedocs/stdlib.md b/core/testdata/packagedocs/stdlib.md deleted file mode 100644 index 5d7432b5..00000000 --- a/core/testdata/packagedocs/stdlib.md +++ /dev/null @@ -1,11 +0,0 @@ -# Module stdlib - -## Kotlin Standard Library - -The Kotlin standard library is a set of functions and types implementing idiomatic patterns when working with collections, -text and files. - -# Package kotlin - -Core functions and types - diff --git a/core/testdata/packages/classInPackage.kt b/core/testdata/packages/classInPackage.kt deleted file mode 100644 index b22273af..00000000 --- a/core/testdata/packages/classInPackage.kt +++ /dev/null @@ -1,3 +0,0 @@ -package simple.name - -class Foo {} diff --git a/core/testdata/packages/dottedNamePackage.kt b/core/testdata/packages/dottedNamePackage.kt deleted file mode 100644 index 38619310..00000000 --- a/core/testdata/packages/dottedNamePackage.kt +++ /dev/null @@ -1 +0,0 @@ -package dot.name
\ No newline at end of file diff --git a/core/testdata/packages/rootPackage.kt b/core/testdata/packages/rootPackage.kt deleted file mode 100644 index e69de29b..00000000 --- a/core/testdata/packages/rootPackage.kt +++ /dev/null diff --git a/core/testdata/packages/simpleNamePackage.kt b/core/testdata/packages/simpleNamePackage.kt deleted file mode 100644 index 2c29f4c7..00000000 --- a/core/testdata/packages/simpleNamePackage.kt +++ /dev/null @@ -1 +0,0 @@ -package simple diff --git a/core/testdata/packages/simpleNamePackage2.kt b/core/testdata/packages/simpleNamePackage2.kt deleted file mode 100644 index 2c29f4c7..00000000 --- a/core/testdata/packages/simpleNamePackage2.kt +++ /dev/null @@ -1 +0,0 @@ -package simple diff --git a/core/testdata/properties/annotatedProperty.kt b/core/testdata/properties/annotatedProperty.kt deleted file mode 100644 index 3c12691b..00000000 --- a/core/testdata/properties/annotatedProperty.kt +++ /dev/null @@ -1 +0,0 @@ -@Strictfp var property = "test"
\ No newline at end of file diff --git a/core/testdata/properties/propertyOverride.kt b/core/testdata/properties/propertyOverride.kt deleted file mode 100644 index 625d1da0..00000000 --- a/core/testdata/properties/propertyOverride.kt +++ /dev/null @@ -1,7 +0,0 @@ -open class Foo() { - open val xyzzy: Int get() = 0 -} - -class Bar(): Foo() { - override val xyzzy: Int get() = 1 -} diff --git a/core/testdata/properties/propertyWithReceiver.kt b/core/testdata/properties/propertyWithReceiver.kt deleted file mode 100644 index e282f6bd..00000000 --- a/core/testdata/properties/propertyWithReceiver.kt +++ /dev/null @@ -1,2 +0,0 @@ -val String.foobar: Int - get() = size() * 2 diff --git a/core/testdata/properties/sinceKotlin.kt b/core/testdata/properties/sinceKotlin.kt deleted file mode 100644 index e96f2349..00000000 --- a/core/testdata/properties/sinceKotlin.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Quite useful [String] - */ -@SinceKotlin("1.1") -val `availableSince1.1`: String = "1.1 rulezz"
\ No newline at end of file diff --git a/core/testdata/properties/valueProperty.kt b/core/testdata/properties/valueProperty.kt deleted file mode 100644 index b87cce57..00000000 --- a/core/testdata/properties/valueProperty.kt +++ /dev/null @@ -1 +0,0 @@ -val property = "test"
\ No newline at end of file diff --git a/core/testdata/properties/valuePropertyWithGetter.kt b/core/testdata/properties/valuePropertyWithGetter.kt deleted file mode 100644 index 64d3848c..00000000 --- a/core/testdata/properties/valuePropertyWithGetter.kt +++ /dev/null @@ -1,2 +0,0 @@ -val property: String - get() = "test"
\ No newline at end of file diff --git a/core/testdata/properties/variableProperty.kt b/core/testdata/properties/variableProperty.kt deleted file mode 100644 index 54ab4595..00000000 --- a/core/testdata/properties/variableProperty.kt +++ /dev/null @@ -1 +0,0 @@ -var property = "test"
\ No newline at end of file diff --git a/core/testdata/properties/variablePropertyWithAccessors.kt b/core/testdata/properties/variablePropertyWithAccessors.kt deleted file mode 100644 index 152fb7d0..00000000 --- a/core/testdata/properties/variablePropertyWithAccessors.kt +++ /dev/null @@ -1,4 +0,0 @@ -var property: String - get() = "test" - set(value) { - }
\ No newline at end of file diff --git a/core/testdata/sourceLinks/dummy.kt b/core/testdata/sourceLinks/dummy.kt deleted file mode 100644 index cbaffe7c..00000000 --- a/core/testdata/sourceLinks/dummy.kt +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Some doc. - */ -fun foo(){ - -} diff --git a/core/testdata/typealias/asTypeBoundWithVariance.kt b/core/testdata/typealias/asTypeBoundWithVariance.kt deleted file mode 100644 index 1aef84d6..00000000 --- a/core/testdata/typealias/asTypeBoundWithVariance.kt +++ /dev/null @@ -1,7 +0,0 @@ -package _typealias.astypebound -class A - -typealias B = A - -class C<out T : B> -class D<in T : B>
\ No newline at end of file diff --git a/core/testdata/typealias/chain.kt b/core/testdata/typealias/chain.kt deleted file mode 100644 index 520be553..00000000 --- a/core/testdata/typealias/chain.kt +++ /dev/null @@ -1,8 +0,0 @@ -package _typealias.chain - -class A - -typealias B = A - -typealias C = B - diff --git a/core/testdata/typealias/deprecated.kt b/core/testdata/typealias/deprecated.kt deleted file mode 100644 index b53d3a20..00000000 --- a/core/testdata/typealias/deprecated.kt +++ /dev/null @@ -1,7 +0,0 @@ -package _typealias.deprecated - -class Lol - -@Deprecated("Not mainstream now") -typealias Kek = Lol - diff --git a/core/testdata/typealias/documented.kt b/core/testdata/typealias/documented.kt deleted file mode 100644 index 3ca110e5..00000000 --- a/core/testdata/typealias/documented.kt +++ /dev/null @@ -1,9 +0,0 @@ -package _typealias.documented - -class A - -/** - * Just typealias - */ -typealias B = A - diff --git a/core/testdata/typealias/functional.kt b/core/testdata/typealias/functional.kt deleted file mode 100644 index dadafa5e..00000000 --- a/core/testdata/typealias/functional.kt +++ /dev/null @@ -1,10 +0,0 @@ -package _typealias.functional - -class A -class B - -typealias Spell = (A) -> B - -fun magic(spell: Spell) { - -}
\ No newline at end of file diff --git a/core/testdata/typealias/generic.kt b/core/testdata/typealias/generic.kt deleted file mode 100644 index 43bc0e23..00000000 --- a/core/testdata/typealias/generic.kt +++ /dev/null @@ -1,7 +0,0 @@ -package _typealias.generic - -interface A<T> - -typealias B = A<Any> - -typealias C<T> = A<T>
\ No newline at end of file diff --git a/core/testdata/typealias/inheritanceFromTypeAlias.kt b/core/testdata/typealias/inheritanceFromTypeAlias.kt deleted file mode 100644 index f929ecd0..00000000 --- a/core/testdata/typealias/inheritanceFromTypeAlias.kt +++ /dev/null @@ -1,7 +0,0 @@ -package _typealias.inheritance - -open class Some - -typealias Same = Some - -class My : Same
\ No newline at end of file diff --git a/core/testdata/typealias/simple.kt b/core/testdata/typealias/simple.kt deleted file mode 100644 index d688a84d..00000000 --- a/core/testdata/typealias/simple.kt +++ /dev/null @@ -1,5 +0,0 @@ -package _typealias.simple - -class A - -typealias B = A
\ No newline at end of file diff --git a/core/testdata/typealias/sinceKotlin.kt b/core/testdata/typealias/sinceKotlin.kt deleted file mode 100644 index 5b76f63a..00000000 --- a/core/testdata/typealias/sinceKotlin.kt +++ /dev/null @@ -1,5 +0,0 @@ -/** - * Documentation - */ -@SinceKotlin("1.1") -typealias `Since 1.1` = String
\ No newline at end of file |