From 39631054c58df5841ea268b7002b820ec55f6e0a Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Thu, 3 Dec 2015 16:22:11 +0100 Subject: restructure Dokka build to use Gradle for everything except for the Maven plugin --- core/testdata/format/accessor.kt | 5 +++ core/testdata/format/accessor.md | 18 +++++++++ core/testdata/format/annotatedTypeParameter.kt | 2 + core/testdata/format/annotatedTypeParameter.md | 8 ++++ core/testdata/format/annotationClass.kt | 1 + core/testdata/format/annotationClass.md | 14 +++++++ core/testdata/format/annotationParams.kt | 1 + core/testdata/format/annotationParams.md | 8 ++++ core/testdata/format/annotations.kt | 6 +++ core/testdata/format/annotations.md | 26 ++++++++++++ core/testdata/format/bracket.html | 14 +++++++ core/testdata/format/bracket.kt | 4 ++ core/testdata/format/brokenLink.html | 14 +++++++ core/testdata/format/brokenLink.kt | 4 ++ core/testdata/format/classWithCompanionObject.html | 46 ++++++++++++++++++++++ core/testdata/format/classWithCompanionObject.kt | 7 ++++ core/testdata/format/classWithCompanionObject.md | 26 ++++++++++++ core/testdata/format/codeSpan.html | 14 +++++++ core/testdata/format/codeSpan.kt | 4 ++ core/testdata/format/companionObjectExtension.kt | 10 +++++ core/testdata/format/companionObjectExtension.md | 23 +++++++++++ .../crossLanguage/kotlinExtendsJava/Bar.html | 37 +++++++++++++++++ .../format/crossLanguage/kotlinExtendsJava/Bar.kt | 6 +++ .../crossLanguage/kotlinExtendsJava/test/Foo.java | 6 +++ core/testdata/format/deprecated.class.html | 41 +++++++++++++++++++ core/testdata/format/deprecated.kt | 5 +++ core/testdata/format/deprecated.package.html | 43 ++++++++++++++++++++ core/testdata/format/emptyDescription.kt | 5 +++ core/testdata/format/emptyDescription.md | 11 ++++++ core/testdata/format/entity.html | 26 ++++++++++++ core/testdata/format/entity.kt | 4 ++ core/testdata/format/enumClass.kt | 4 ++ core/testdata/format/enumClass.md | 15 +++++++ core/testdata/format/enumClass.value.md | 8 ++++ core/testdata/format/extensionFunctionParameter.kt | 1 + core/testdata/format/extensionFunctionParameter.md | 8 ++++ core/testdata/format/extensions.class.md | 16 ++++++++ core/testdata/format/extensions.kt | 19 +++++++++ core/testdata/format/extensions.package.md | 11 ++++++ .../format/functionWithDefaultParameter.kt | 1 + .../format/functionWithDefaultParameter.md | 8 ++++ core/testdata/format/htmlEscaping.html | 14 +++++++ core/testdata/format/htmlEscaping.kt | 4 ++ core/testdata/format/inheritedExtensions.kt | 11 ++++++ core/testdata/format/inheritedExtensions.md | 21 ++++++++++ core/testdata/format/inheritedMembers.kt | 12 ++++++ core/testdata/format/inheritedMembers.md | 38 ++++++++++++++++++ core/testdata/format/javaCodeInParam.java | 5 +++ core/testdata/format/javaCodeInParam.md | 21 ++++++++++ core/testdata/format/javaCodeLiteralTags.java | 6 +++ core/testdata/format/javaCodeLiteralTags.md | 23 +++++++++++ core/testdata/format/javaDeprecated.html | 14 +++++++ core/testdata/format/javaDeprecated.java | 5 +++ core/testdata/format/javaLinkTag.html | 36 +++++++++++++++++ core/testdata/format/javaLinkTag.java | 6 +++ core/testdata/format/javaLinkTagWithLabel.html | 36 +++++++++++++++++ core/testdata/format/javaLinkTagWithLabel.java | 6 +++ core/testdata/format/javaSeeTag.html | 38 ++++++++++++++++++ core/testdata/format/javaSeeTag.java | 6 +++ core/testdata/format/javaSpaceInAuthor.java | 5 +++ core/testdata/format/javaSpaceInAuthor.md | 19 +++++++++ core/testdata/format/javaSupertype.html | 35 ++++++++++++++++ core/testdata/format/javaSupertype.java | 8 ++++ core/testdata/format/javadocHtml.java | 14 +++++++ core/testdata/format/javadocHtml.md | 27 +++++++++++++ core/testdata/format/javadocOrderedList.java | 8 ++++ core/testdata/format/javadocOrderedList.md | 20 ++++++++++ core/testdata/format/linkWithLabel.html | 37 +++++++++++++++++ core/testdata/format/linkWithLabel.kt | 6 +++ core/testdata/format/nullability.kt | 5 +++ core/testdata/format/nullability.md | 20 ++++++++++ core/testdata/format/operatorOverloading.kt | 3 ++ core/testdata/format/operatorOverloading.md | 8 ++++ core/testdata/format/orderedList.html | 30 ++++++++++++++ core/testdata/format/orderedList.kt | 8 ++++ core/testdata/format/overloads.html | 23 +++++++++++ core/testdata/format/overloads.kt | 5 +++ core/testdata/format/overloadsWithDescription.html | 21 ++++++++++ core/testdata/format/overloadsWithDescription.kt | 15 +++++++ .../format/overloadsWithDifferentDescriptions.html | 30 ++++++++++++++ .../format/overloadsWithDifferentDescriptions.kt | 15 +++++++ core/testdata/format/overridingFunction.kt | 7 ++++ core/testdata/format/overridingFunction.md | 9 +++++ core/testdata/format/paramTag.kt | 6 +++ core/testdata/format/paramTag.md | 14 +++++++ core/testdata/format/parameterAnchor.html | 17 ++++++++ core/testdata/format/parameterAnchor.kt | 6 +++ core/testdata/format/parenthesis.html | 14 +++++++ core/testdata/format/parenthesis.kt | 4 ++ core/testdata/format/propertyVar.kt | 1 + core/testdata/format/propertyVar.md | 8 ++++ core/testdata/format/reifiedTypeParameter.kt | 3 ++ core/testdata/format/reifiedTypeParameter.md | 8 ++++ core/testdata/format/see.html | 28 +++++++++++++ core/testdata/format/see.kt | 12 ++++++ core/testdata/format/starProjection.kt | 3 ++ core/testdata/format/starProjection.md | 8 ++++ core/testdata/format/summarizeSignatures.kt | 20 ++++++++++ core/testdata/format/summarizeSignatures.md | 23 +++++++++++ .../testdata/format/summarizeSignaturesProperty.kt | 20 ++++++++++ .../testdata/format/summarizeSignaturesProperty.md | 23 +++++++++++ core/testdata/format/throwsTag.kt | 5 +++ core/testdata/format/throwsTag.md | 13 ++++++ core/testdata/format/tripleBackticks.html | 16 ++++++++ core/testdata/format/tripleBackticks.kt | 7 ++++ core/testdata/format/typeLink.html | 24 +++++++++++ core/testdata/format/typeLink.kt | 5 +++ core/testdata/format/typeParameterBounds.kt | 6 +++ core/testdata/format/typeParameterBounds.md | 11 ++++++ core/testdata/format/typeParameterVariance.kt | 2 + core/testdata/format/typeParameterVariance.md | 14 +++++++ core/testdata/format/typeProjectionVariance.kt | 1 + core/testdata/format/typeProjectionVariance.md | 8 ++++ core/testdata/format/varargsFunction.kt | 1 + core/testdata/format/varargsFunction.md | 8 ++++ 115 files changed, 1549 insertions(+) create mode 100644 core/testdata/format/accessor.kt create mode 100644 core/testdata/format/accessor.md create mode 100644 core/testdata/format/annotatedTypeParameter.kt create mode 100644 core/testdata/format/annotatedTypeParameter.md create mode 100644 core/testdata/format/annotationClass.kt create mode 100644 core/testdata/format/annotationClass.md create mode 100644 core/testdata/format/annotationParams.kt create mode 100644 core/testdata/format/annotationParams.md create mode 100644 core/testdata/format/annotations.kt create mode 100644 core/testdata/format/annotations.md create mode 100644 core/testdata/format/bracket.html create mode 100644 core/testdata/format/bracket.kt create mode 100644 core/testdata/format/brokenLink.html create mode 100644 core/testdata/format/brokenLink.kt create mode 100644 core/testdata/format/classWithCompanionObject.html create mode 100644 core/testdata/format/classWithCompanionObject.kt create mode 100644 core/testdata/format/classWithCompanionObject.md create mode 100644 core/testdata/format/codeSpan.html create mode 100644 core/testdata/format/codeSpan.kt create mode 100644 core/testdata/format/companionObjectExtension.kt create mode 100644 core/testdata/format/companionObjectExtension.md create mode 100644 core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html create mode 100644 core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt create mode 100644 core/testdata/format/crossLanguage/kotlinExtendsJava/test/Foo.java create mode 100644 core/testdata/format/deprecated.class.html create mode 100644 core/testdata/format/deprecated.kt create mode 100644 core/testdata/format/deprecated.package.html create mode 100644 core/testdata/format/emptyDescription.kt create mode 100644 core/testdata/format/emptyDescription.md create mode 100644 core/testdata/format/entity.html create mode 100644 core/testdata/format/entity.kt create mode 100644 core/testdata/format/enumClass.kt create mode 100644 core/testdata/format/enumClass.md create mode 100644 core/testdata/format/enumClass.value.md create mode 100644 core/testdata/format/extensionFunctionParameter.kt create mode 100644 core/testdata/format/extensionFunctionParameter.md create mode 100644 core/testdata/format/extensions.class.md create mode 100644 core/testdata/format/extensions.kt create mode 100644 core/testdata/format/extensions.package.md create mode 100644 core/testdata/format/functionWithDefaultParameter.kt create mode 100644 core/testdata/format/functionWithDefaultParameter.md create mode 100644 core/testdata/format/htmlEscaping.html create mode 100644 core/testdata/format/htmlEscaping.kt create mode 100644 core/testdata/format/inheritedExtensions.kt create mode 100644 core/testdata/format/inheritedExtensions.md create mode 100644 core/testdata/format/inheritedMembers.kt create mode 100644 core/testdata/format/inheritedMembers.md create mode 100644 core/testdata/format/javaCodeInParam.java create mode 100644 core/testdata/format/javaCodeInParam.md create mode 100644 core/testdata/format/javaCodeLiteralTags.java create mode 100644 core/testdata/format/javaCodeLiteralTags.md create mode 100644 core/testdata/format/javaDeprecated.html create mode 100644 core/testdata/format/javaDeprecated.java create mode 100644 core/testdata/format/javaLinkTag.html create mode 100644 core/testdata/format/javaLinkTag.java create mode 100644 core/testdata/format/javaLinkTagWithLabel.html create mode 100644 core/testdata/format/javaLinkTagWithLabel.java create mode 100644 core/testdata/format/javaSeeTag.html create mode 100644 core/testdata/format/javaSeeTag.java create mode 100644 core/testdata/format/javaSpaceInAuthor.java create mode 100644 core/testdata/format/javaSpaceInAuthor.md create mode 100644 core/testdata/format/javaSupertype.html create mode 100644 core/testdata/format/javaSupertype.java create mode 100644 core/testdata/format/javadocHtml.java create mode 100644 core/testdata/format/javadocHtml.md create mode 100644 core/testdata/format/javadocOrderedList.java create mode 100644 core/testdata/format/javadocOrderedList.md create mode 100644 core/testdata/format/linkWithLabel.html create mode 100644 core/testdata/format/linkWithLabel.kt create mode 100644 core/testdata/format/nullability.kt create mode 100644 core/testdata/format/nullability.md create mode 100644 core/testdata/format/operatorOverloading.kt create mode 100644 core/testdata/format/operatorOverloading.md create mode 100644 core/testdata/format/orderedList.html create mode 100644 core/testdata/format/orderedList.kt create mode 100644 core/testdata/format/overloads.html create mode 100644 core/testdata/format/overloads.kt create mode 100644 core/testdata/format/overloadsWithDescription.html create mode 100644 core/testdata/format/overloadsWithDescription.kt create mode 100644 core/testdata/format/overloadsWithDifferentDescriptions.html create mode 100644 core/testdata/format/overloadsWithDifferentDescriptions.kt create mode 100644 core/testdata/format/overridingFunction.kt create mode 100644 core/testdata/format/overridingFunction.md create mode 100644 core/testdata/format/paramTag.kt create mode 100644 core/testdata/format/paramTag.md create mode 100644 core/testdata/format/parameterAnchor.html create mode 100644 core/testdata/format/parameterAnchor.kt create mode 100644 core/testdata/format/parenthesis.html create mode 100644 core/testdata/format/parenthesis.kt create mode 100644 core/testdata/format/propertyVar.kt create mode 100644 core/testdata/format/propertyVar.md create mode 100644 core/testdata/format/reifiedTypeParameter.kt create mode 100644 core/testdata/format/reifiedTypeParameter.md create mode 100644 core/testdata/format/see.html create mode 100644 core/testdata/format/see.kt create mode 100644 core/testdata/format/starProjection.kt create mode 100644 core/testdata/format/starProjection.md create mode 100644 core/testdata/format/summarizeSignatures.kt create mode 100644 core/testdata/format/summarizeSignatures.md create mode 100644 core/testdata/format/summarizeSignaturesProperty.kt create mode 100644 core/testdata/format/summarizeSignaturesProperty.md create mode 100644 core/testdata/format/throwsTag.kt create mode 100644 core/testdata/format/throwsTag.md create mode 100644 core/testdata/format/tripleBackticks.html create mode 100644 core/testdata/format/tripleBackticks.kt create mode 100644 core/testdata/format/typeLink.html create mode 100644 core/testdata/format/typeLink.kt create mode 100644 core/testdata/format/typeParameterBounds.kt create mode 100644 core/testdata/format/typeParameterBounds.md create mode 100644 core/testdata/format/typeParameterVariance.kt create mode 100644 core/testdata/format/typeParameterVariance.md create mode 100644 core/testdata/format/typeProjectionVariance.kt create mode 100644 core/testdata/format/typeProjectionVariance.md create mode 100644 core/testdata/format/varargsFunction.kt create mode 100644 core/testdata/format/varargsFunction.md (limited to 'core/testdata/format') diff --git a/core/testdata/format/accessor.kt b/core/testdata/format/accessor.kt new file mode 100644 index 00000000..5a4d1742 --- /dev/null +++ b/core/testdata/format/accessor.kt @@ -0,0 +1,5 @@ +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 new file mode 100644 index 00000000..8279f452 --- /dev/null +++ b/core/testdata/format/accessor.md @@ -0,0 +1,18 @@ +[test](test/index) / [C](test/-c/index) / [x](test/-c/x) + + +# 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 new file mode 100644 index 00000000..cc3bfc1a --- /dev/null +++ b/core/testdata/format/annotatedTypeParameter.kt @@ -0,0 +1,2 @@ +public fun containsAll(elements: Collection<@UnsafeVariance E>): @UnsafeVariance E { +} diff --git a/core/testdata/format/annotatedTypeParameter.md b/core/testdata/format/annotatedTypeParameter.md new file mode 100644 index 00000000..7d26a162 --- /dev/null +++ b/core/testdata/format/annotatedTypeParameter.md @@ -0,0 +1,8 @@ +[test](test/index) / [containsAll](test/contains-all) + + +# containsAll + +`fun <E> containsAll(elements: Collection<@UnsafeVariance E>): @UnsafeVariance E` + + diff --git a/core/testdata/format/annotationClass.kt b/core/testdata/format/annotationClass.kt new file mode 100644 index 00000000..89d494fb --- /dev/null +++ b/core/testdata/format/annotationClass.kt @@ -0,0 +1 @@ +annotation class fancy diff --git a/core/testdata/format/annotationClass.md b/core/testdata/format/annotationClass.md new file mode 100644 index 00000000..03548aa3 --- /dev/null +++ b/core/testdata/format/annotationClass.md @@ -0,0 +1,14 @@ +[test](test/index) / [fancy](test/fancy/index) + + +# fancy + +`annotation class fancy` + + + +### Constructors + + +| [<init>](test/fancy/-init-) | `fancy()` | + diff --git a/core/testdata/format/annotationParams.kt b/core/testdata/format/annotationParams.kt new file mode 100644 index 00000000..f259a740 --- /dev/null +++ b/core/testdata/format/annotationParams.kt @@ -0,0 +1 @@ +@JvmName("FFF") fun f() {} diff --git a/core/testdata/format/annotationParams.md b/core/testdata/format/annotationParams.md new file mode 100644 index 00000000..8cdd6e96 --- /dev/null +++ b/core/testdata/format/annotationParams.md @@ -0,0 +1,8 @@ +[test](test/index) / [f](test/f) + + +# f + +`@JvmName("FFF") fun f(): Unit` + + diff --git a/core/testdata/format/annotations.kt b/core/testdata/format/annotations.kt new file mode 100644 index 00000000..57f76249 --- /dev/null +++ b/core/testdata/format/annotations.kt @@ -0,0 +1,6 @@ +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 new file mode 100644 index 00000000..b898d55c --- /dev/null +++ b/core/testdata/format/annotations.md @@ -0,0 +1,26 @@ +[test](test/index) / [Foo](test/-foo/index) + + +# Foo + +`data class Foo` + + + +### Constructors + + +| [<init>](test/-foo/-init-) | `Foo()` | + + +### Properties + + +| [x](test/-foo/x) | `val x: Int` | + + +### Functions + + +| [bar](test/-foo/bar) | `fun bar(notInlined: () -> Unit): Unit` | + diff --git a/core/testdata/format/bracket.html b/core/testdata/format/bracket.html new file mode 100644 index 00000000..5630073d --- /dev/null +++ b/core/testdata/format/bracket.html @@ -0,0 +1,14 @@ + + +test / foo + + +test / foo
+
+

foo

+fun foo(): Unit
+

bar[]

+
+
+ + diff --git a/core/testdata/format/bracket.kt b/core/testdata/format/bracket.kt new file mode 100644 index 00000000..d41b0073 --- /dev/null +++ b/core/testdata/format/bracket.kt @@ -0,0 +1,4 @@ +/** + * bar[] + */ +fun foo() {} diff --git a/core/testdata/format/brokenLink.html b/core/testdata/format/brokenLink.html new file mode 100644 index 00000000..32135787 --- /dev/null +++ b/core/testdata/format/brokenLink.html @@ -0,0 +1,14 @@ + + +test / f + + +test / f
+
+

f

+fun f(): Unit
+

This references noSuchIdentifier.

+
+
+ + diff --git a/core/testdata/format/brokenLink.kt b/core/testdata/format/brokenLink.kt new file mode 100644 index 00000000..268a986e --- /dev/null +++ b/core/testdata/format/brokenLink.kt @@ -0,0 +1,4 @@ +/** + * This references [noSuchIdentifier]. + */ +fun f() { } diff --git a/core/testdata/format/classWithCompanionObject.html b/core/testdata/format/classWithCompanionObject.html new file mode 100644 index 00000000..be9247ea --- /dev/null +++ b/core/testdata/format/classWithCompanionObject.html @@ -0,0 +1,46 @@ + + +test / Klass + + +test / Klass
+
+

Klass

+class Klass
+
+
+

Constructors

+ + + + + + + +
+<init> +Klass()
+

Companion Object Properties

+ + + + + + + +
+x +val x: Int
+

Companion Object Functions

+ + + + + + + +
+foo +fun foo(): Unit
+ + diff --git a/core/testdata/format/classWithCompanionObject.kt b/core/testdata/format/classWithCompanionObject.kt new file mode 100644 index 00000000..fdbd915d --- /dev/null +++ b/core/testdata/format/classWithCompanionObject.kt @@ -0,0 +1,7 @@ +class Klass() { + companion object { + val x = 1 + + fun foo() {} + } +} diff --git a/core/testdata/format/classWithCompanionObject.md b/core/testdata/format/classWithCompanionObject.md new file mode 100644 index 00000000..9398c3d3 --- /dev/null +++ b/core/testdata/format/classWithCompanionObject.md @@ -0,0 +1,26 @@ +[test](test/index) / [Klass](test/-klass/index) + + +# Klass + +`class Klass` + + + +### Constructors + + +| [<init>](test/-klass/-init-) | `Klass()` | + + +### Companion Object Properties + + +| [x](test/-klass/x) | `val x: Int` | + + +### Companion Object Functions + + +| [foo](test/-klass/foo) | `fun foo(): Unit` | + diff --git a/core/testdata/format/codeSpan.html b/core/testdata/format/codeSpan.html new file mode 100644 index 00000000..cc553043 --- /dev/null +++ b/core/testdata/format/codeSpan.html @@ -0,0 +1,14 @@ + + +test / foo + + +test / foo
+
+

foo

+fun foo(): Unit
+

This is a code span.

+
+
+ + diff --git a/core/testdata/format/codeSpan.kt b/core/testdata/format/codeSpan.kt new file mode 100644 index 00000000..645f454a --- /dev/null +++ b/core/testdata/format/codeSpan.kt @@ -0,0 +1,4 @@ +/** + * This is a `code span`. + */ +fun foo() {} \ No newline at end of file diff --git a/core/testdata/format/companionObjectExtension.kt b/core/testdata/format/companionObjectExtension.kt new file mode 100644 index 00000000..f452de2c --- /dev/null +++ b/core/testdata/format/companionObjectExtension.kt @@ -0,0 +1,10 @@ +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 new file mode 100644 index 00000000..271da5b0 --- /dev/null +++ b/core/testdata/format/companionObjectExtension.md @@ -0,0 +1,23 @@ +[test](test/index) / [Foo](test/-foo/index) + + +# Foo + +`class Foo` + + + +### Constructors + + +| [<init>](test/-foo/-init-) | `Foo()` | + + +### Companion Object Extension Properties + + +| [x](test/x) | `val Foo.Default.x: Int` +The default object property. + + | + diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html new file mode 100644 index 00000000..e7b139d8 --- /dev/null +++ b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html @@ -0,0 +1,37 @@ + + +test / test.Bar + + +test / test / Bar
+
+

Bar

+class Bar : Foo
+

See xyzzy

+
+
+

Constructors

+ + + + + + + +
+<init> +Bar()

See xyzzy

+
+

Inherited Functions

+ + + + + + + +
+xyzzy +open fun xyzzy(): Unit
+ + diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt new file mode 100644 index 00000000..102782f9 --- /dev/null +++ b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.kt @@ -0,0 +1,6 @@ +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 new file mode 100644 index 00000000..7c143030 --- /dev/null +++ b/core/testdata/format/crossLanguage/kotlinExtendsJava/test/Foo.java @@ -0,0 +1,6 @@ +package test; + +public class Foo { + public void xyzzy() { + } +} diff --git a/core/testdata/format/deprecated.class.html b/core/testdata/format/deprecated.class.html new file mode 100644 index 00000000..69da63a1 --- /dev/null +++ b/core/testdata/format/deprecated.class.html @@ -0,0 +1,41 @@ + + + + +test / C
+
+

C

+class C
+Deprecated: This class sucks
+
+
+
+test / f
+
+

f

+fun f(): Unit
+Deprecated: This function sucks
+
+
+
+test / p
+
+

p

+val p: Int
+Deprecated: This property sucks
+
+
+
+

Constructors

+ + + + + + + +
+<init> +C()
+ + diff --git a/core/testdata/format/deprecated.kt b/core/testdata/format/deprecated.kt new file mode 100644 index 00000000..4fc568c2 --- /dev/null +++ b/core/testdata/format/deprecated.kt @@ -0,0 +1,5 @@ +@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 new file mode 100644 index 00000000..dd80471c --- /dev/null +++ b/core/testdata/format/deprecated.package.html @@ -0,0 +1,43 @@ + + +test / root package + + +test
+
+

Package

+

Types

+ + + + + + + +
+C +class C
+

Properties

+ + + + + + + +
+p +val p: Int
+

Functions

+ + + + + + + +
+f +fun f(): Unit
+ + diff --git a/core/testdata/format/emptyDescription.kt b/core/testdata/format/emptyDescription.kt new file mode 100644 index 00000000..3ed81dfa --- /dev/null +++ b/core/testdata/format/emptyDescription.kt @@ -0,0 +1,5 @@ +/** + * Function fn + */ +fun fn() { +} \ No newline at end of file diff --git a/core/testdata/format/emptyDescription.md b/core/testdata/format/emptyDescription.md new file mode 100644 index 00000000..e82e7228 --- /dev/null +++ b/core/testdata/format/emptyDescription.md @@ -0,0 +1,11 @@ +[test](test/index) / [fn](test/fn) + + +# fn + +`fun fn(): Unit` + +Function fn + + + diff --git a/core/testdata/format/entity.html b/core/testdata/format/entity.html new file mode 100644 index 00000000..a939faad --- /dev/null +++ b/core/testdata/format/entity.html @@ -0,0 +1,26 @@ + + +test / Bar + + +test / Bar
+
+

Bar

+class Bar
+

Copyright © JetBrains 2015 "

+
+
+

Constructors

+ + + + + + + +
+<init> +Bar()

Copyright © JetBrains 2015 "

+
+ + diff --git a/core/testdata/format/entity.kt b/core/testdata/format/entity.kt new file mode 100644 index 00000000..163d2ee6 --- /dev/null +++ b/core/testdata/format/entity.kt @@ -0,0 +1,4 @@ +/** + * Copyright © JetBrains 2015 " + */ +class Bar {} diff --git a/core/testdata/format/enumClass.kt b/core/testdata/format/enumClass.kt new file mode 100644 index 00000000..c1af69d8 --- /dev/null +++ b/core/testdata/format/enumClass.kt @@ -0,0 +1,4 @@ +public enum class InlineOption { + LOCAL_CONTINUE_AND_BREAK, + ONLY_LOCAL_RETURN +} diff --git a/core/testdata/format/enumClass.md b/core/testdata/format/enumClass.md new file mode 100644 index 00000000..7a0e03ff --- /dev/null +++ b/core/testdata/format/enumClass.md @@ -0,0 +1,15 @@ +[test](test/index) / [InlineOption](test/-inline-option/index) + + +# InlineOption + +`enum class InlineOption` + + + +### Enum Values + + +| [LOCAL_CONTINUE_AND_BREAK](test/-inline-option/-l-o-c-a-l_-c-o-n-t-i-n-u-e_-a-n-d_-b-r-e-a-k) | | +| [ONLY_LOCAL_RETURN](test/-inline-option/-o-n-l-y_-l-o-c-a-l_-r-e-t-u-r-n) | | + diff --git a/core/testdata/format/enumClass.value.md b/core/testdata/format/enumClass.value.md new file mode 100644 index 00000000..bcb685d1 --- /dev/null +++ b/core/testdata/format/enumClass.value.md @@ -0,0 +1,8 @@ +[test](test/index) / [InlineOption](test/-inline-option/index) / [LOCAL_CONTINUE_AND_BREAK](test/-inline-option/-l-o-c-a-l_-c-o-n-t-i-n-u-e_-a-n-d_-b-r-e-a-k) + + +# LOCAL_CONTINUE_AND_BREAK + +`LOCAL_CONTINUE_AND_BREAK` + + diff --git a/core/testdata/format/extensionFunctionParameter.kt b/core/testdata/format/extensionFunctionParameter.kt new file mode 100644 index 00000000..bfb344b9 --- /dev/null +++ b/core/testdata/format/extensionFunctionParameter.kt @@ -0,0 +1 @@ +public inline fun T.apply(f: T.() -> Unit): T { f(); return this } diff --git a/core/testdata/format/extensionFunctionParameter.md b/core/testdata/format/extensionFunctionParameter.md new file mode 100644 index 00000000..6980912d --- /dev/null +++ b/core/testdata/format/extensionFunctionParameter.md @@ -0,0 +1,8 @@ +[test](test/index) / [apply](test/apply) + + +# apply + +`inline fun <T> T.apply(f: T.() -> Unit): T` + + diff --git a/core/testdata/format/extensions.class.md b/core/testdata/format/extensions.class.md new file mode 100644 index 00000000..c66cdb01 --- /dev/null +++ b/core/testdata/format/extensions.class.md @@ -0,0 +1,16 @@ +[test](test/index) / [foo](test/foo/index) / [kotlin.String](test/foo/kotlin.-string/index) + + +### Extensions for kotlin.String + + +| [fn](test/foo/kotlin.-string/fn) | `fun String.fn(): Unit` +`fun String.fn(x: Int): Unit` +Function with receiver + + | +| [foobar](test/foo/kotlin.-string/foobar) | `val String.foobar: Int` +Property with receiver. + + | + diff --git a/core/testdata/format/extensions.kt b/core/testdata/format/extensions.kt new file mode 100644 index 00000000..6f2eff9d --- /dev/null +++ b/core/testdata/format/extensions.kt @@ -0,0 +1,19 @@ +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 new file mode 100644 index 00000000..76ff3676 --- /dev/null +++ b/core/testdata/format/extensions.package.md @@ -0,0 +1,11 @@ +[test](test/index) / [foo](test/foo/index) + + +## Package foo + + +### Extensions for External Classes + + +| [kotlin.String](test/foo/kotlin.-string/index) | | + diff --git a/core/testdata/format/functionWithDefaultParameter.kt b/core/testdata/format/functionWithDefaultParameter.kt new file mode 100644 index 00000000..3a3a102f --- /dev/null +++ b/core/testdata/format/functionWithDefaultParameter.kt @@ -0,0 +1 @@ +fun f(x: String = "") {} diff --git a/core/testdata/format/functionWithDefaultParameter.md b/core/testdata/format/functionWithDefaultParameter.md new file mode 100644 index 00000000..21e9eff7 --- /dev/null +++ b/core/testdata/format/functionWithDefaultParameter.md @@ -0,0 +1,8 @@ +[test](test/index) / [f](test/f) + + +# f + +`fun f(x: String = ""): Unit` + + diff --git a/core/testdata/format/htmlEscaping.html b/core/testdata/format/htmlEscaping.html new file mode 100644 index 00000000..a485c08f --- /dev/null +++ b/core/testdata/format/htmlEscaping.html @@ -0,0 +1,14 @@ + + +test / x + + +test / x
+
+

x

+fun <T> x(): T?
+

Special characters: < is "less than", > is "greater than", & is "ampersand"

+
+
+ + diff --git a/core/testdata/format/htmlEscaping.kt b/core/testdata/format/htmlEscaping.kt new file mode 100644 index 00000000..8778d8a5 --- /dev/null +++ b/core/testdata/format/htmlEscaping.kt @@ -0,0 +1,4 @@ +/** + * Special characters: < is "less than", > is "greater than", & is "ampersand" + */ +fun x(): T? = null diff --git a/core/testdata/format/inheritedExtensions.kt b/core/testdata/format/inheritedExtensions.kt new file mode 100644 index 00000000..e38fe00d --- /dev/null +++ b/core/testdata/format/inheritedExtensions.kt @@ -0,0 +1,11 @@ +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 new file mode 100644 index 00000000..79137eac --- /dev/null +++ b/core/testdata/format/inheritedExtensions.md @@ -0,0 +1,21 @@ +[test](test/index) / [Bar](test/-bar/index) + + +# Bar + +`class Bar : [Foo](test/-foo/index)` + + + +### Constructors + + +| [<init>](test/-bar/-init-) | `Bar()` | + + +### Extension Functions + + +| [first](test/first) | `fun [Foo](test/-foo/index).first(): Unit` | +| [second](test/second) | `fun [Bar](test/-bar/index).second(): Unit` | + diff --git a/core/testdata/format/inheritedMembers.kt b/core/testdata/format/inheritedMembers.kt new file mode 100644 index 00000000..2d0c4ca1 --- /dev/null +++ b/core/testdata/format/inheritedMembers.kt @@ -0,0 +1,12 @@ +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 new file mode 100644 index 00000000..d58d3974 --- /dev/null +++ b/core/testdata/format/inheritedMembers.md @@ -0,0 +1,38 @@ +[test](test/index) / [Bar](test/-bar/index) + + +# Bar + +`class Bar : [Foo](test/-foo/index)` + + + +### Constructors + + +| [<init>](test/-bar/-init-) | `Bar()` | + + +### Properties + + +| [secondProp](test/-bar/second-prop) | `val secondProp: Int` | + + +### Inherited Properties + + +| [firstProp](test/-foo/first-prop) | `val firstProp: Int` | + + +### Functions + + +| [second](test/-bar/second) | `fun second(): Unit` | + + +### Inherited Functions + + +| [first](test/-foo/first) | `fun first(): Unit` | + diff --git a/core/testdata/format/javaCodeInParam.java b/core/testdata/format/javaCodeInParam.java new file mode 100644 index 00000000..73025fcc --- /dev/null +++ b/core/testdata/format/javaCodeInParam.java @@ -0,0 +1,5 @@ +/** + * @param T this is {@code some code} and other text + */ +class C { +} diff --git a/core/testdata/format/javaCodeInParam.md b/core/testdata/format/javaCodeInParam.md new file mode 100644 index 00000000..b1d2d871 --- /dev/null +++ b/core/testdata/format/javaCodeInParam.md @@ -0,0 +1,21 @@ +[test](test/index) / [C](test/-c/index) + + +# C + +`protected open class C<T : Any>` + + + + +### Parameters + +`T` - this is `some code` and other text + + + +### Constructors + + +| [<init>](test/-c/-init-) | `C()` | + diff --git a/core/testdata/format/javaCodeLiteralTags.java b/core/testdata/format/javaCodeLiteralTags.java new file mode 100644 index 00000000..e71ddaa7 --- /dev/null +++ b/core/testdata/format/javaCodeLiteralTags.java @@ -0,0 +1,6 @@ +/** + *

{@code AC}

+ *

{@literal AC}

+ */ +class C { +} diff --git a/core/testdata/format/javaCodeLiteralTags.md b/core/testdata/format/javaCodeLiteralTags.md new file mode 100644 index 00000000..83c9cc33 --- /dev/null +++ b/core/testdata/format/javaCodeLiteralTags.md @@ -0,0 +1,23 @@ +[test](test/index) / [C](test/-c/index) + + +# C + +`protected open class C` + + +`A<B>C` + + +A<B>C + + + + + + +### Constructors + + +| [<init>](test/-c/-init-) | `C()` | + diff --git a/core/testdata/format/javaDeprecated.html b/core/testdata/format/javaDeprecated.html new file mode 100644 index 00000000..236c6490 --- /dev/null +++ b/core/testdata/format/javaDeprecated.html @@ -0,0 +1,14 @@ + + +test / Foo.foo + + +test / Foo / foo
+
+

foo

+open fun foo(): Unit
+Deprecated: use #bar instead

+
+
+ + diff --git a/core/testdata/format/javaDeprecated.java b/core/testdata/format/javaDeprecated.java new file mode 100644 index 00000000..9694a444 --- /dev/null +++ b/core/testdata/format/javaDeprecated.java @@ -0,0 +1,5 @@ +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 new file mode 100644 index 00000000..1b6921ab --- /dev/null +++ b/core/testdata/format/javaLinkTag.html @@ -0,0 +1,36 @@ + + +test / Foo + + +test / Foo
+
+

Foo

+protected open class Foo
+

Call #bar() to do the job.

+
+
+

Constructors

+ + + + + + + +
+<init> +Foo()
+

Functions

+ + + + + + + +
+bar +open fun bar(): Unit
+ + diff --git a/core/testdata/format/javaLinkTag.java b/core/testdata/format/javaLinkTag.java new file mode 100644 index 00000000..84f761c6 --- /dev/null +++ b/core/testdata/format/javaLinkTag.java @@ -0,0 +1,6 @@ +/** + * 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 new file mode 100644 index 00000000..aabfbc58 --- /dev/null +++ b/core/testdata/format/javaLinkTagWithLabel.html @@ -0,0 +1,36 @@ + + +test / Foo + + +test / Foo
+
+

Foo

+protected open class Foo
+

Call this wonderful method to do the job.

+
+
+

Constructors

+ + + + + + + +
+<init> +Foo()
+

Functions

+ + + + + + + +
+bar +open fun bar(): Unit
+ + diff --git a/core/testdata/format/javaLinkTagWithLabel.java b/core/testdata/format/javaLinkTagWithLabel.java new file mode 100644 index 00000000..1db5ad70 --- /dev/null +++ b/core/testdata/format/javaLinkTagWithLabel.java @@ -0,0 +1,6 @@ +/** + * 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 new file mode 100644 index 00000000..a6813df3 --- /dev/null +++ b/core/testdata/format/javaSeeTag.html @@ -0,0 +1,38 @@ + + +test / Foo + + +test / Foo
+
+

Foo

+open class Foo
+

+See Also
+#bar
+
+
+

Constructors

+ + + + + + + +
+<init> +Foo()
+

Functions

+ + + + + + + +
+bar +open fun bar(): Unit
+ + diff --git a/core/testdata/format/javaSeeTag.java b/core/testdata/format/javaSeeTag.java new file mode 100644 index 00000000..94a24606 --- /dev/null +++ b/core/testdata/format/javaSeeTag.java @@ -0,0 +1,6 @@ +/** + * @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 new file mode 100644 index 00000000..f980ae07 --- /dev/null +++ b/core/testdata/format/javaSpaceInAuthor.java @@ -0,0 +1,5 @@ +/** + * @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 new file mode 100644 index 00000000..4d19ed01 --- /dev/null +++ b/core/testdata/format/javaSpaceInAuthor.md @@ -0,0 +1,19 @@ +[test](test/index) / [C](test/-c/index) + + +# C + +`protected open class C` + + + +**Author** +Dmitry Jemerov + + + +### Constructors + + +| [<init>](test/-c/-init-) | `C()` | + diff --git a/core/testdata/format/javaSupertype.html b/core/testdata/format/javaSupertype.html new file mode 100644 index 00000000..4c847281 --- /dev/null +++ b/core/testdata/format/javaSupertype.html @@ -0,0 +1,35 @@ + + +test / C.Bar + + +test / C / Bar
+
+

Bar

+open class Bar : Foo
+
+
+

Constructors

+ + + + + + + +
+<init> +Bar()
+

Functions

+ + + + + + + +
+returnFoo +open fun returnFoo(foo: Foo): Foo
+ + diff --git a/core/testdata/format/javaSupertype.java b/core/testdata/format/javaSupertype.java new file mode 100644 index 00000000..b3142ff6 --- /dev/null +++ b/core/testdata/format/javaSupertype.java @@ -0,0 +1,8 @@ +class C { + public static class Foo { + } + + public static class Bar extends Foo { + public Foo returnFoo(Foo foo) { return foo; } + } +} diff --git a/core/testdata/format/javadocHtml.java b/core/testdata/format/javadocHtml.java new file mode 100644 index 00000000..622116b2 --- /dev/null +++ b/core/testdata/format/javadocHtml.java @@ -0,0 +1,14 @@ +/** + * Bold + * Strong + * Italic + * Emphasized + *

Paragraph

+ * Strikethrough + * Deleted + * Code + * 
Block code
+ *
  • List Item
+ */ +public class C { +} diff --git a/core/testdata/format/javadocHtml.md b/core/testdata/format/javadocHtml.md new file mode 100644 index 00000000..db71cc3b --- /dev/null +++ b/core/testdata/format/javadocHtml.md @@ -0,0 +1,27 @@ +[test](test/index) / [C](test/-c/index) + + +# C + +`open class C` + +**Bold** **Strong** *Italic* *Emphasized* +Paragraph + + ~~Strikethrough~~ ~~Deleted~~ `Code` +``` +Block code +``` + + * List Item + + + + + + +### Constructors + + +| [<init>](test/-c/-init-) | `C()` | + diff --git a/core/testdata/format/javadocOrderedList.java b/core/testdata/format/javadocOrderedList.java new file mode 100644 index 00000000..c32d9032 --- /dev/null +++ b/core/testdata/format/javadocOrderedList.java @@ -0,0 +1,8 @@ +/** + *
    + *
  1. Rinse
    2. + *
  2. Repeat
    3. + *
+ */ +public class Bar { +} diff --git a/core/testdata/format/javadocOrderedList.md b/core/testdata/format/javadocOrderedList.md new file mode 100644 index 00000000..02a3c095 --- /dev/null +++ b/core/testdata/format/javadocOrderedList.md @@ -0,0 +1,20 @@ +[test](test/index) / [Bar](test/-bar/index) + + +# Bar + +`open class Bar` + + 1. Rinse + 1. Repeat + + + + + + +### Constructors + + +| [<init>](test/-bar/-init-) | `Bar()` | + diff --git a/core/testdata/format/linkWithLabel.html b/core/testdata/format/linkWithLabel.html new file mode 100644 index 00000000..75769ffd --- /dev/null +++ b/core/testdata/format/linkWithLabel.html @@ -0,0 +1,37 @@ + + +test / Bar + + +test / Bar
+
+

Bar

+class Bar
+

Use this method for best results.

+
+
+

Constructors

+ + + + + + + +
+<init> +Bar()

Use this method for best results.

+
+

Functions

+ + + + + + + +
+foo +fun foo(): Unit
+ + diff --git a/core/testdata/format/linkWithLabel.kt b/core/testdata/format/linkWithLabel.kt new file mode 100644 index 00000000..4a85c505 --- /dev/null +++ b/core/testdata/format/linkWithLabel.kt @@ -0,0 +1,6 @@ +/** + * Use [this method][Bar.foo] for best results. + */ +class Bar { + fun foo() {} +} diff --git a/core/testdata/format/nullability.kt b/core/testdata/format/nullability.kt new file mode 100644 index 00000000..d1d4545b --- /dev/null +++ b/core/testdata/format/nullability.kt @@ -0,0 +1,5 @@ +class C { + fun foo(): Comparable? { + return null + } +} diff --git a/core/testdata/format/nullability.md b/core/testdata/format/nullability.md new file mode 100644 index 00000000..ee50a0a5 --- /dev/null +++ b/core/testdata/format/nullability.md @@ -0,0 +1,20 @@ +[test](test/index) / [C](test/-c/index) + + +# C + +`class C<T>` + + + +### Constructors + + +| [<init>](test/-c/-init-) | `C()` | + + +### Functions + + +| [foo](test/-c/foo) | `fun foo(): Comparable<T>?` | + diff --git a/core/testdata/format/operatorOverloading.kt b/core/testdata/format/operatorOverloading.kt new file mode 100644 index 00000000..6fe78e45 --- /dev/null +++ b/core/testdata/format/operatorOverloading.kt @@ -0,0 +1,3 @@ +class C { + fun plus(other: C): C +} diff --git a/core/testdata/format/operatorOverloading.md b/core/testdata/format/operatorOverloading.md new file mode 100644 index 00000000..05fe3206 --- /dev/null +++ b/core/testdata/format/operatorOverloading.md @@ -0,0 +1,8 @@ +[test](test/index) / [C](test/-c/index) / [plus](test/-c/plus) + + +# plus + +`fun plus(other: [C](test/-c/index)): [C](test/-c/index)` + + diff --git a/core/testdata/format/orderedList.html b/core/testdata/format/orderedList.html new file mode 100644 index 00000000..9917568f --- /dev/null +++ b/core/testdata/format/orderedList.html @@ -0,0 +1,30 @@ + + +test / Bar + + +test / Bar
+
+

Bar

+class Bar
+

Usage instructions:

+

  1. Rinse

    +

  2. Repeat

    +

+
+
+
+

Constructors

+ + + + + + + +
+<init> +Bar()

Usage instructions:

+
+ + diff --git a/core/testdata/format/orderedList.kt b/core/testdata/format/orderedList.kt new file mode 100644 index 00000000..03681c7a --- /dev/null +++ b/core/testdata/format/orderedList.kt @@ -0,0 +1,8 @@ +/** + * Usage instructions: + * + * 1. Rinse + * 1. Repeat + */ +class Bar { +} diff --git a/core/testdata/format/overloads.html b/core/testdata/format/overloads.html new file mode 100644 index 00000000..752f3989 --- /dev/null +++ b/core/testdata/format/overloads.html @@ -0,0 +1,23 @@ + + +test / root package + + +test
+
+

Package

+

Functions

+ + + + + + + +
+f +fun f(x: Int): Unit
+fun f(x: String): Unit

Performs an action on x.

+
+ + diff --git a/core/testdata/format/overloads.kt b/core/testdata/format/overloads.kt new file mode 100644 index 00000000..dcd2d097 --- /dev/null +++ b/core/testdata/format/overloads.kt @@ -0,0 +1,5 @@ +/** 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 new file mode 100644 index 00000000..a0efb472 --- /dev/null +++ b/core/testdata/format/overloadsWithDescription.html @@ -0,0 +1,21 @@ + + +test / f + + +test / f
+
+

f

+fun f(x: Int): Unit
+fun f(x: String): Unit
+

Performs an action on x.

+

This is a long description.

+
+
+

Parameters

+ +x - the value to perform the action on.
+
+
+ + diff --git a/core/testdata/format/overloadsWithDescription.kt b/core/testdata/format/overloadsWithDescription.kt new file mode 100644 index 00000000..740e642f --- /dev/null +++ b/core/testdata/format/overloadsWithDescription.kt @@ -0,0 +1,15 @@ +/** + * 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 new file mode 100644 index 00000000..30a37e75 --- /dev/null +++ b/core/testdata/format/overloadsWithDifferentDescriptions.html @@ -0,0 +1,30 @@ + + +test / f + + +test / f
+
+

f

+fun f(x: Int): Unit
+

Performs an action on x.

+

This is a long description.

+
+
+

Parameters

+ +x - the int value to perform the action on.
+
+
+fun f(x: String): Unit
+

Performs an action on x.

+

This is a long description.

+
+
+

Parameters

+ +x - the string value to perform the action on.
+
+
+ + diff --git a/core/testdata/format/overloadsWithDifferentDescriptions.kt b/core/testdata/format/overloadsWithDifferentDescriptions.kt new file mode 100644 index 00000000..ad3169b0 --- /dev/null +++ b/core/testdata/format/overloadsWithDifferentDescriptions.kt @@ -0,0 +1,15 @@ +/** + * 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 new file mode 100644 index 00000000..d7329489 --- /dev/null +++ b/core/testdata/format/overridingFunction.kt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 00000000..2c898b9c --- /dev/null +++ b/core/testdata/format/overridingFunction.md @@ -0,0 +1,9 @@ +[test](test/index) / [D](test/-d/index) / [f](test/-d/f) + + +# f + +`fun f(): Unit` +Overrides [C.f](test/-c/f) + + diff --git a/core/testdata/format/paramTag.kt b/core/testdata/format/paramTag.kt new file mode 100644 index 00000000..47e471f5 --- /dev/null +++ b/core/testdata/format/paramTag.kt @@ -0,0 +1,6 @@ +/** + * @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 new file mode 100644 index 00000000..882083fe --- /dev/null +++ b/core/testdata/format/paramTag.md @@ -0,0 +1,14 @@ +[test](test/index) / [f](test/f) + + +# 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 + + diff --git a/core/testdata/format/parameterAnchor.html b/core/testdata/format/parameterAnchor.html new file mode 100644 index 00000000..c5920fb7 --- /dev/null +++ b/core/testdata/format/parameterAnchor.html @@ -0,0 +1,17 @@ + + +test / processFiles + + +test / processFiles
+
+

processFiles

+fun <T> processFiles(processor: () -> T): List<T>
+

Runs processor for each file and collects its results into single list

+

Parameters

+ +processor - function to receive context for symbol resolution and file for processing
+
+
+ + diff --git a/core/testdata/format/parameterAnchor.kt b/core/testdata/format/parameterAnchor.kt new file mode 100644 index 00000000..ae36ee4c --- /dev/null +++ b/core/testdata/format/parameterAnchor.kt @@ -0,0 +1,6 @@ +/** + * 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(processor: () -> T): List { +} diff --git a/core/testdata/format/parenthesis.html b/core/testdata/format/parenthesis.html new file mode 100644 index 00000000..c36b311b --- /dev/null +++ b/core/testdata/format/parenthesis.html @@ -0,0 +1,14 @@ + + +test / foo + + +test / foo
+
+

foo

+fun foo(): Unit
+

foo (bar)

+
+
+ + diff --git a/core/testdata/format/parenthesis.kt b/core/testdata/format/parenthesis.kt new file mode 100644 index 00000000..b906f64a --- /dev/null +++ b/core/testdata/format/parenthesis.kt @@ -0,0 +1,4 @@ +/** + * foo (bar) + */ +fun foo() {} diff --git a/core/testdata/format/propertyVar.kt b/core/testdata/format/propertyVar.kt new file mode 100644 index 00000000..88be1a7a --- /dev/null +++ b/core/testdata/format/propertyVar.kt @@ -0,0 +1 @@ +var x = 1 \ No newline at end of file diff --git a/core/testdata/format/propertyVar.md b/core/testdata/format/propertyVar.md new file mode 100644 index 00000000..f2110992 --- /dev/null +++ b/core/testdata/format/propertyVar.md @@ -0,0 +1,8 @@ +[test](test/index) / [x](test/x) + + +# x + +`var x: Int` + + diff --git a/core/testdata/format/reifiedTypeParameter.kt b/core/testdata/format/reifiedTypeParameter.kt new file mode 100644 index 00000000..00fa1dc9 --- /dev/null +++ b/core/testdata/format/reifiedTypeParameter.kt @@ -0,0 +1,3 @@ +inline fun f() { + +} diff --git a/core/testdata/format/reifiedTypeParameter.md b/core/testdata/format/reifiedTypeParameter.md new file mode 100644 index 00000000..2e96018e --- /dev/null +++ b/core/testdata/format/reifiedTypeParameter.md @@ -0,0 +1,8 @@ +[test](test/index) / [f](test/f) + + +# f + +`inline fun <reified T> f(): Unit` + + diff --git a/core/testdata/format/see.html b/core/testdata/format/see.html new file mode 100644 index 00000000..b3ffb74b --- /dev/null +++ b/core/testdata/format/see.html @@ -0,0 +1,28 @@ + + + + +test / quux
+
+

quux

+fun quux():