aboutsummaryrefslogtreecommitdiff
path: root/core/testdata/format
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2016-07-04 19:48:27 +0200
committerDmitry Jemerov <yole@jetbrains.com>2016-07-04 19:48:27 +0200
commitc0064d2b43ec30237d0d39bf5a9aaa4ce5e14744 (patch)
tree603144496856c6730ef3e1076f5ecc4cc94a11f4 /core/testdata/format
parent625ea7d5d679399a24877d4f6988d58ce2662a8c (diff)
downloaddokka-c0064d2b43ec30237d0d39bf5a9aaa4ce5e14744.tar.gz
dokka-c0064d2b43ec30237d0d39bf5a9aaa4ce5e14744.tar.bz2
dokka-c0064d2b43ec30237d0d39bf5a9aaa4ce5e14744.zip
Rewrite output generation; much cleaner Markdown and HTML generated. Resolves #71, #72
Diffstat (limited to 'core/testdata/format')
-rw-r--r--core/testdata/format/accessor.md8
-rw-r--r--core/testdata/format/annotatedTypeParameter.md5
-rw-r--r--core/testdata/format/annotationClass.md4
-rw-r--r--core/testdata/format/annotationClass.package.md3
-rw-r--r--core/testdata/format/annotationParams.md5
-rw-r--r--core/testdata/format/annotations.md10
-rw-r--r--core/testdata/format/arrayAverage.md15
-rw-r--r--core/testdata/format/bracket.html4
-rw-r--r--core/testdata/format/brokenLink.html4
-rw-r--r--core/testdata/format/classWithCompanionObject.html4
-rw-r--r--core/testdata/format/classWithCompanionObject.md8
-rw-r--r--core/testdata/format/codeBlock.md14
-rw-r--r--core/testdata/format/codeSpan.html4
-rw-r--r--core/testdata/format/companionObjectExtension.md11
-rw-r--r--core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html7
-rw-r--r--core/testdata/format/deprecated.class.html6
-rw-r--r--core/testdata/format/emptyDescription.md3
-rw-r--r--core/testdata/format/entity.html7
-rw-r--r--core/testdata/format/enumClass.md4
-rw-r--r--core/testdata/format/enumClass.value.md5
-rw-r--r--core/testdata/format/exceptionClass.md6
-rw-r--r--core/testdata/format/exceptionClass.package.md5
-rw-r--r--core/testdata/format/extensionFunctionParameter.md5
-rw-r--r--core/testdata/format/extensionWithDocumentedReceiver.md4
-rw-r--r--core/testdata/format/extensions.class.md13
-rw-r--r--core/testdata/format/extensions.package.md3
-rw-r--r--core/testdata/format/functionWithDefaultParameter.md5
-rw-r--r--core/testdata/format/genericInheritedExtensions.md12
-rw-r--r--core/testdata/format/gfm/listInTableCell.kt8
-rw-r--r--core/testdata/format/gfm/listInTableCell.md17
-rw-r--r--core/testdata/format/gfm/sample.md19
-rw-r--r--core/testdata/format/htmlEscaping.html4
-rw-r--r--core/testdata/format/inapplicableExtensionFunctions.md10
-rw-r--r--core/testdata/format/inheritedCompanionObjectProperties.md14
-rw-r--r--core/testdata/format/inheritedExtensions.md12
-rw-r--r--core/testdata/format/inheritedMembers.md14
-rw-r--r--core/testdata/format/javaCodeInParam.md14
-rw-r--r--core/testdata/format/javaCodeLiteralTags.md22
-rw-r--r--core/testdata/format/javaDeprecated.html4
-rw-r--r--core/testdata/format/javaLinkTag.html9
-rw-r--r--core/testdata/format/javaLinkTagWithLabel.html9
-rw-r--r--core/testdata/format/javaSeeTag.html8
-rw-r--r--core/testdata/format/javaSpaceInAuthor.md13
-rw-r--r--core/testdata/format/javaSupertype.html4
-rw-r--r--core/testdata/format/javadocHtml.md30
-rw-r--r--core/testdata/format/javadocOrderedList.md15
-rw-r--r--core/testdata/format/jdkLinks.md12
-rw-r--r--core/testdata/format/linkWithLabel.html7
-rw-r--r--core/testdata/format/linkWithStarProjection.html4
-rw-r--r--core/testdata/format/markdownInLinks.html4
-rw-r--r--core/testdata/format/multipleTypeParameterConstraints.md5
-rw-r--r--core/testdata/format/nullability.md10
-rw-r--r--core/testdata/format/operatorOverloading.md5
-rw-r--r--core/testdata/format/orderedList.html14
-rw-r--r--core/testdata/format/overloads.html3
-rw-r--r--core/testdata/format/overloadsWithDescription.html11
-rw-r--r--core/testdata/format/overloadsWithDifferentDescriptions.html27
-rw-r--r--core/testdata/format/overridingFunction.md3
-rw-r--r--core/testdata/format/paramTag.md7
-rw-r--r--core/testdata/format/parameterAnchor.html9
-rw-r--r--core/testdata/format/parenthesis.html4
-rw-r--r--core/testdata/format/propertyVar.md5
-rw-r--r--core/testdata/format/receiverParameterTypeBound.md8
-rw-r--r--core/testdata/format/reifiedTypeParameter.md5
-rw-r--r--core/testdata/format/returnWithLink.html4
-rw-r--r--core/testdata/format/see.html13
-rw-r--r--core/testdata/format/shadowedExtensionFunctions.md13
-rw-r--r--core/testdata/format/starProjection.md4
-rw-r--r--core/testdata/format/summarizeSignatures.md13
-rw-r--r--core/testdata/format/summarizeSignaturesProperty.md13
-rw-r--r--core/testdata/format/throwsTag.md5
-rw-r--r--core/testdata/format/tripleBackticks.html7
-rw-r--r--core/testdata/format/typeLink.html4
-rw-r--r--core/testdata/format/typeParameterBounds.md8
-rw-r--r--core/testdata/format/typeParameterVariance.md6
-rw-r--r--core/testdata/format/typeProjectionVariance.md4
-rw-r--r--core/testdata/format/uninterpretedEmphasisCharacters.html4
-rw-r--r--core/testdata/format/varargsFunction.md5
-rw-r--r--core/testdata/format/website/returnTag.md7
-rw-r--r--core/testdata/format/website/sample.md14
80 files changed, 164 insertions, 513 deletions
diff --git a/core/testdata/format/accessor.md b/core/testdata/format/accessor.md
index eb326727..dcdef0f8 100644
--- a/core/testdata/format/accessor.md
+++ b/core/testdata/format/accessor.md
@@ -1,6 +1,5 @@
[test](test/index) / [C](test/-c/index) / [x](test/-c/x)
-
# x
`var x: String`
@@ -9,14 +8,7 @@
The getter returns an empty string.
-
-
-
**Setter**
The setter does nothing.
-
-
-
-
diff --git a/core/testdata/format/annotatedTypeParameter.md b/core/testdata/format/annotatedTypeParameter.md
index 7d26a162..0aa1b9d7 100644
--- a/core/testdata/format/annotatedTypeParameter.md
+++ b/core/testdata/format/annotatedTypeParameter.md
@@ -1,8 +1,5 @@
[test](test/index) / [containsAll](test/contains-all)
-
# containsAll
-`fun &lt;E&gt; containsAll(elements:&nbsp;Collection&lt;@UnsafeVariance E&gt;): @UnsafeVariance E`
-
-
+`fun <E> containsAll(elements: Collection<@UnsafeVariance E>): @UnsafeVariance E` \ No newline at end of file
diff --git a/core/testdata/format/annotationClass.md b/core/testdata/format/annotationClass.md
index 03548aa3..2f4da736 100644
--- a/core/testdata/format/annotationClass.md
+++ b/core/testdata/format/annotationClass.md
@@ -1,14 +1,10 @@
[test](test/index) / [fancy](test/fancy/index)
-
# fancy
`annotation class fancy`
-
-
### Constructors
-
| [&lt;init&gt;](test/fancy/-init-) | `fancy()` |
diff --git a/core/testdata/format/annotationClass.package.md b/core/testdata/format/annotationClass.package.md
index f7c8405d..f52b28b6 100644
--- a/core/testdata/format/annotationClass.package.md
+++ b/core/testdata/format/annotationClass.package.md
@@ -1,11 +1,8 @@
[test](test/index)
-
## Package &lt;root&gt;
-
### Annotations
-
| [fancy](test/fancy/index) | `annotation class fancy` |
diff --git a/core/testdata/format/annotationParams.md b/core/testdata/format/annotationParams.md
index 8cdd6e96..132078ce 100644
--- a/core/testdata/format/annotationParams.md
+++ b/core/testdata/format/annotationParams.md
@@ -1,8 +1,5 @@
[test](test/index) / [f](test/f)
-
# f
-`@JvmName("FFF") fun f(): Unit`
-
-
+`@JvmName("FFF") fun f(): Unit` \ No newline at end of file
diff --git a/core/testdata/format/annotations.md b/core/testdata/format/annotations.md
index b898d55c..cc27d5af 100644
--- a/core/testdata/format/annotations.md
+++ b/core/testdata/format/annotations.md
@@ -1,26 +1,18 @@
[test](test/index) / [Foo](test/-foo/index)
-
# Foo
`data class Foo`
-
-
### Constructors
-
| [&lt;init&gt;](test/-foo/-init-) | `Foo()` |
-
### Properties
-
| [x](test/-foo/x) | `val x: Int` |
-
### Functions
-
-| [bar](test/-foo/bar) | `fun bar(notInlined:&nbsp;()&nbsp;-&gt;&nbsp;Unit): Unit` |
+| [bar](test/-foo/bar) | `fun bar(notInlined: () -> Unit): Unit` |
diff --git a/core/testdata/format/arrayAverage.md b/core/testdata/format/arrayAverage.md
index 9ffa3650..7cc31c47 100644
--- a/core/testdata/format/arrayAverage.md
+++ b/core/testdata/format/arrayAverage.md
@@ -1,25 +1,14 @@
[test](test/index) / [XArray](test/-x-array/index)
-
# XArray
-`class XArray&lt;T&gt;`
-
-
+`class XArray<T>`
### Constructors
-
| [&lt;init&gt;](test/-x-array/-init-) | `XArray()` |
-
### Extension Functions
-
-| [average](test/average) | `fun [XArray](test/-x-array/index)&lt;out&nbsp;Byte&gt;.average(): Double`
-`fun [XArray](test/-x-array/index)&lt;out&nbsp;Double&gt;.average(): Double`
-`fun [XArray](test/-x-array/index)&lt;out&nbsp;Float&gt;.average(): Double`
-`fun [XArray](test/-x-array/index)&lt;out&nbsp;Int&gt;.average(): Double`
-`fun [XArray](test/-x-array/index)&lt;out&nbsp;Long&gt;.average(): Double`
-`fun [XArray](test/-x-array/index)&lt;out&nbsp;Short&gt;.average(): Double` |
+| [average](test/average) | `fun `[`XArray`](test/-x-array/index)`<out Byte>.average(): Double`<br>`fun `[`XArray`](test/-x-array/index)`<out Double>.average(): Double`<br>`fun `[`XArray`](test/-x-array/index)`<out Float>.average(): Double`<br>`fun `[`XArray`](test/-x-array/index)`<out Int>.average(): Double`<br>`fun `[`XArray`](test/-x-array/index)`<out Long>.average(): Double`<br>`fun `[`XArray`](test/-x-array/index)`<out Short>.average(): Double` |
diff --git a/core/testdata/format/bracket.html b/core/testdata/format/bracket.html
index f96c6459..8f4310c3 100644
--- a/core/testdata/format/bracket.html
+++ b/core/testdata/format/bracket.html
@@ -7,9 +7,7 @@
<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><br/>
+<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>
-<br/>
-<br/>
</BODY>
</HTML>
diff --git a/core/testdata/format/brokenLink.html b/core/testdata/format/brokenLink.html
index 860ffc26..8803781a 100644
--- a/core/testdata/format/brokenLink.html
+++ b/core/testdata/format/brokenLink.html
@@ -7,9 +7,7 @@
<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><br/>
+<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>
-<br/>
-<br/>
</BODY>
</HTML>
diff --git a/core/testdata/format/classWithCompanionObject.html b/core/testdata/format/classWithCompanionObject.html
index 679420bd..376bae9b 100644
--- a/core/testdata/format/classWithCompanionObject.html
+++ b/core/testdata/format/classWithCompanionObject.html
@@ -6,9 +6,7 @@
<a href="test/index">test</a>&nbsp;/&nbsp;<a href="test/-klass/index">Klass</a><br/>
<br/>
<h1>Klass</h1>
-<code><span class="keyword">class </span><span class="identifier">Klass</span></code><br/>
-<br/>
-<br/>
+<code><span class="keyword">class </span><span class="identifier">Klass</span></code>
<h3>Constructors</h3>
<table>
<tbody>
diff --git a/core/testdata/format/classWithCompanionObject.md b/core/testdata/format/classWithCompanionObject.md
index 9398c3d3..45684c0e 100644
--- a/core/testdata/format/classWithCompanionObject.md
+++ b/core/testdata/format/classWithCompanionObject.md
@@ -1,26 +1,18 @@
[test](test/index) / [Klass](test/-klass/index)
-
# Klass
`class Klass`
-
-
### Constructors
-
| [&lt;init&gt;](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/codeBlock.md b/core/testdata/format/codeBlock.md
index 08710390..016ea9e8 100644
--- a/core/testdata/format/codeBlock.md
+++ b/core/testdata/format/codeBlock.md
@@ -1,31 +1,19 @@
[test](test/index) / [Throws](test/-throws/index)
-
# 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
-
-| [&lt;init&gt;](test/-throws/-init-) | `Throws()`
-This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.
-
- |
+| [&lt;init&gt;](test/-throws/-init-) | `Throws()`<br>This annotation indicates what exceptions should be declared by a function when compiled to a JVM method. |
diff --git a/core/testdata/format/codeSpan.html b/core/testdata/format/codeSpan.html
index 216a15e9..f28e6957 100644
--- a/core/testdata/format/codeSpan.html
+++ b/core/testdata/format/codeSpan.html
@@ -7,9 +7,7 @@
<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><br/>
+<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>
-<br/>
-<br/>
</BODY>
</HTML>
diff --git a/core/testdata/format/companionObjectExtension.md b/core/testdata/format/companionObjectExtension.md
index 271da5b0..e019c184 100644
--- a/core/testdata/format/companionObjectExtension.md
+++ b/core/testdata/format/companionObjectExtension.md
@@ -1,23 +1,14 @@
[test](test/index) / [Foo](test/-foo/index)
-
# Foo
`class Foo`
-
-
### Constructors
-
| [&lt;init&gt;](test/-foo/-init-) | `Foo()` |
-
### Companion Object Extension Properties
-
-| [x](test/x) | `val Foo.Default.x: Int`
-The default object property.
-
- |
+| [x](test/x) | `val Foo.Default.x: Int`<br>The default object property. |
diff --git a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html
index 295366b3..ca0725a0 100644
--- a/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html
+++ b/core/testdata/format/crossLanguage/kotlinExtendsJava/Bar.html
@@ -6,10 +6,8 @@
<a href="test/index">test</a>&nbsp;/&nbsp;<a href="test/test/index">test</a>&nbsp;/&nbsp;<a href="test/test/-bar/index">Bar</a><br/>
<br/>
<h1>Bar</h1>
-<code><span class="keyword">class </span><span class="identifier">Bar</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="test/test/-foo/index"><span class="identifier">Foo</span></a></code><br/>
+<code><span class="keyword">class </span><span class="identifier">Bar</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="test/test/-foo/index"><span class="identifier">Foo</span></a></code>
<p>See <a href="test/test/-foo/xyzzy">xyzzy</a></p>
-<br/>
-<br/>
<h3>Constructors</h3>
<table>
<tbody>
@@ -17,7 +15,8 @@
<td>
<a href="test/test/-bar/-init-">&lt;init&gt;</a></td>
<td>
-<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code><p>See <a href="test/test/-foo/xyzzy">xyzzy</a></p>
+<code><span class="identifier">Bar</span><span class="symbol">(</span><span class="symbol">)</span></code>
+<p>See <a href="test/test/-foo/xyzzy">xyzzy</a></p>
</td>
</tr>
</tbody>
diff --git a/core/testdata/format/deprecat