diff options
| author | Dmitry Jemerov <yole@jetbrains.com> | 2015-02-10 19:35:27 +0100 |
|---|---|---|
| committer | Dmitry Jemerov <yole@jetbrains.com> | 2015-02-10 19:35:27 +0100 |
| commit | ebbf265dbe9d5fe37e56c9baa567edaf21dd16fa (patch) | |
| tree | 09c521046ed883024690f1ed7ceb7f4dd840e411 /test/data | |
| parent | a187baa606f1dd6ce63bc38247f4b5331d78f42b (diff) | |
| download | dokka-ebbf265dbe9d5fe37e56c9baa567edaf21dd16fa.tar.gz dokka-ebbf265dbe9d5fe37e56c9baa567edaf21dd16fa.tar.bz2 dokka-ebbf265dbe9d5fe37e56c9baa567edaf21dd16fa.zip | |
much nicer html output for overloads
Diffstat (limited to 'test/data')
29 files changed, 63 insertions, 113 deletions
diff --git a/test/data/format/accessor.get.md b/test/data/format/accessor.get.md index b4da2a03..2f6ffbeb 100644 --- a/test/data/format/accessor.get.md +++ b/test/data/format/accessor.get.md @@ -3,10 +3,6 @@ # get - -``` -get(): String -``` - +`get(): String` diff --git a/test/data/format/accessor.set.md b/test/data/format/accessor.set.md index 8b9db263..aadb77da 100644 --- a/test/data/format/accessor.set.md +++ b/test/data/format/accessor.set.md @@ -3,10 +3,6 @@ # set - -``` -set(value: String) -``` - +`set(value: String)` diff --git a/test/data/format/annotationClass.md b/test/data/format/annotationClass.md index 301eff08..cefd5212 100644 --- a/test/data/format/annotationClass.md +++ b/test/data/format/annotationClass.md @@ -3,11 +3,7 @@ # fancy - -``` -annotation class fancy -``` - +`annotation class fancy` diff --git a/test/data/format/annotationParams.md b/test/data/format/annotationParams.md index 6bbdc0e5..8fd26b94 100644 --- a/test/data/format/annotationParams.md +++ b/test/data/format/annotationParams.md @@ -3,10 +3,6 @@ # f - -``` -inlineOptions([InlineOption.LOCAL_CONTINUE_AND_BREAK]) fun f(): Unit -``` - +`inlineOptions([InlineOption.LOCAL_CONTINUE_AND_BREAK]) fun f(): Unit` diff --git a/test/data/format/annotations.md b/test/data/format/annotations.md index e745213e..d7435adf 100644 --- a/test/data/format/annotations.md +++ b/test/data/format/annotations.md @@ -3,11 +3,7 @@ # Foo - -``` -data class Foo -``` - +`data class Foo` diff --git a/test/data/format/brokenLink.html b/test/data/format/brokenLink.html index 39fe8617..7c2585b8 100644 --- a/test/data/format/brokenLink.html +++ b/test/data/format/brokenLink.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">f</a><br/> <br/> <h1>f</h1> -<pre><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></pre><p>This references <a href="#">noSuchIdentifier</a>.</p> +<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/> +<p>This references <a href="#">noSuchIdentifier</a>.</p> <br/> <br/> </BODY> diff --git a/test/data/format/classWithClassObject.html b/test/data/format/classWithClassObject.html index 5ccb5b7e..c1b18041 100644 --- a/test/data/format/classWithClassObject.html +++ b/test/data/format/classWithClassObject.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">Klass</a><br/> <br/> <h1>Klass</h1> -<pre><code><span class="keyword">class </span><span class="identifier">Klass</span></code></pre><br/> +<code><span class="keyword">class </span><span class="identifier">Klass</span></code><br/> +<br/> <br/> <h3>Constructors</h3> <table> diff --git a/test/data/format/classWithClassObject.md b/test/data/format/classWithClassObject.md index 796ecce2..b1191099 100644 --- a/test/data/format/classWithClassObject.md +++ b/test/data/format/classWithClassObject.md @@ -3,11 +3,7 @@ # Klass - -``` -class Klass -``` - +`class Klass` diff --git a/test/data/format/codeSpan.html b/test/data/format/codeSpan.html index 37bb62f0..d2209b83 100644 --- a/test/data/format/codeSpan.html +++ b/test/data/format/codeSpan.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">foo</a><br/> <br/> <h1>foo</h1> -<pre><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></pre><p>This is a <code>code span</code>.</p> +<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/> +<p>This is a <code>code span</code>.</p> <br/> <br/> </BODY> diff --git a/test/data/format/deprecated.class.html b/test/data/format/deprecated.class.html index 1442026c..030dd12b 100644 --- a/test/data/format/deprecated.class.html +++ b/test/data/format/deprecated.class.html @@ -5,19 +5,22 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">C</a><br/> <br/> <h1>C</h1> -<pre><code><span class="keyword">class </span><s><span class="identifier">C</span></s></code></pre><strong>Deprecated: </strong>This class sucks<br/> +<code><span class="keyword">class </span><s><span class="identifier">C</span></s></code><br/> +<strong>Deprecated: </strong>This class sucks<br/> <br/> <br/> <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">f</a><br/> <br/> <h1>f</h1> -<pre><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></pre><strong>Deprecated: </strong>This function sucks<br/> +<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/> <br/> <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">p</a><br/> <br/> <h1>p</h1> -<pre><code><span class="keyword">val </span><s><span class="identifier">p</span></s><span class="symbol">: </span><span class="identifier">Int</span></code></pre><strong>Deprecated: </strong>This property sucks<br/> +<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/> <br/> <h3>Constructors</h3> diff --git a/test/data/format/deprecated.package.html b/test/data/format/deprecated.package.html index 13a5edb2..000d2015 100644 --- a/test/data/format/deprecated.package.html +++ b/test/data/format/deprecated.package.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a><br/> <br/> <h1></h1> -<pre><code><span class="keyword">package</span> <span class="identifier"></span></code></pre><br/> +<code><span class="keyword">package</span> <span class="identifier"></span></code><br/> +<br/> <br/> <h3>Types</h3> <table> diff --git a/test/data/format/emptyDescription.md b/test/data/format/emptyDescription.md index 5e8c05c0..6b2fd2b4 100644 --- a/test/data/format/emptyDescription.md +++ b/test/data/format/emptyDescription.md @@ -3,11 +3,7 @@ # fn - -``` -fun fn(): Unit -``` - +`fun fn(): Unit` Function fn diff --git a/test/data/format/enumClass.md b/test/data/format/enumClass.md index 7b3d242b..e260c18f 100644 --- a/test/data/format/enumClass.md +++ b/test/data/format/enumClass.md @@ -3,11 +3,7 @@ # InlineOption - -``` -public enum class InlineOption -``` - +`public enum class InlineOption` diff --git a/test/data/format/enumClass.value.md b/test/data/format/enumClass.value.md index 70dc8eb8..bec97d80 100644 --- a/test/data/format/enumClass.value.md +++ b/test/data/format/enumClass.value.md @@ -3,10 +3,6 @@ # LOCAL_CONTINUE_AND_BREAK - -``` -LOCAL_CONTINUE_AND_BREAK -``` - +`LOCAL_CONTINUE_AND_BREAK` diff --git a/test/data/format/extensions.package.md b/test/data/format/extensions.package.md index 13f40457..a456e64e 100644 --- a/test/data/format/extensions.package.md +++ b/test/data/format/extensions.package.md @@ -3,11 +3,7 @@ # foo - -``` -package foo -``` - +`package foo` diff --git a/test/data/format/functionWithDefaultParameter.md b/test/data/format/functionWithDefaultParameter.md index 1acab0ef..435fe6d2 100644 --- a/test/data/format/functionWithDefaultParameter.md +++ b/test/data/format/functionWithDefaultParameter.md @@ -3,10 +3,6 @@ # f - -``` -fun f(x: String = ""): Unit -``` - +`fun f(x: String = ""): Unit` diff --git a/test/data/format/htmlEscaping.html b/test/data/format/htmlEscaping.html index 0767d642..c031447a 100644 --- a/test/data/format/htmlEscaping.html +++ b/test/data/format/htmlEscaping.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">x</a><br/> <br/> <h1>x</h1> -<pre><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><span class="identifier">T?</span></code></pre><p>Special characters: < is "less than", > is "greater than", & is "ampersand"</p> +<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><span class="identifier">T?</span></code><br/> +<p>Special characters: < is "less than", > is "greater than", & is "ampersand"</p> <br/> <br/> </BODY> diff --git a/test/data/format/overloads.html b/test/data/format/overloads.html index 92296825..7a7bd6cf 100644 --- a/test/data/format/overloads.html +++ b/test/data/format/overloads.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a><br/> <br/> <h1></h1> -<pre><code><span class="keyword">package</span> <span class="identifier"></span></code></pre><br/> +<code><span class="keyword">package</span> <span class="identifier"></span></code><br/> +<br/> <br/> <h3>Functions</h3> <table> diff --git a/test/data/format/overloadsWithDescription.html b/test/data/format/overloadsWithDescription.html index 37f5cd08..4d43cb05 100644 --- a/test/data/format/overloadsWithDescription.html +++ b/test/data/format/overloadsWithDescription.html @@ -6,14 +6,16 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">f</a><br/> <br/> <h1>f</h1> -<pre><code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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></pre><pre><code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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></pre><p>Performs an action on <a href="out.html">x</a>.</p> -<br/> -<br/> +<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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">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><br/> +<p>Performs an action on <a href="out.html">x</a>.</p> <h3>Description</h3> <p>This is a long description.</p> <br/> <br/> <h3>Parameters</h3> <code>x</code> - the value to perform the action on.<br/> +<br/> +<br/> </BODY> </HTML> diff --git a/test/data/format/overloadsWithDifferentDescriptions.html b/test/data/format/overloadsWithDifferentDescriptions.html index 3ce974af..6d174529 100644 --- a/test/data/format/overloadsWithDifferentDescriptions.html +++ b/test/data/format/overloadsWithDifferentDescriptions.html @@ -6,23 +6,25 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">f</a><br/> <br/> <h1>f</h1> -<pre><code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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></pre><p>Performs an action on x.</p> -<br/> -<br/> +<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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/> +<p>Performs an action on x.</p> <h3>Description</h3> <p>This is a long description.</p> <br/> <br/> <h3>Parameters</h3> <code>x</code> - the int value to perform the action on.<br/> -<pre><code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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></pre><p>Performs an action on x.</p> <br/> <br/> +<code><span class="keyword">fun </span><span class="identifier">f</span><span class="symbol">(</span><span class="identifier">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><br/> +<p>Performs an action on x.</p> <h3>Description</h3> <p>This is a long description.</p> <br/> <br/> <h3>Parameters</h3> <code>x</code> - the string value to perform the action on.<br/> +<br/> +<br/> </BODY> </HTML> diff --git a/test/data/format/overridingFunction.md b/test/data/format/overridingFunction.md index b53b3e13..6670ca00 100644 --- a/test/data/format/overridingFunction.md +++ b/test/data/format/overridingFunction.md @@ -3,11 +3,7 @@ # f - -``` -fun f(): Unit -``` - +`fun f(): Unit` Overrides [C.f](out.md) diff --git a/test/data/format/paramTag.md b/test/data/format/paramTag.md index 02927668..5f324699 100644 --- a/test/data/format/paramTag.md +++ b/test/data/format/paramTag.md @@ -3,16 +3,12 @@ # f - -``` -fun f(x: String, y: Int): Unit -``` - - - +`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/test/data/format/parenthesis.html b/test/data/format/parenthesis.html index 9e739443..f3328d90 100644 --- a/test/data/format/parenthesis.html +++ b/test/data/format/parenthesis.html @@ -6,7 +6,8 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">foo</a><br/> <br/> <h1>foo</h1> -<pre><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></pre><p>foo (bar)</p> +<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/> +<p>foo (bar)</p> <br/> <br/> </BODY> diff --git a/test/data/format/propertyVar.md b/test/data/format/propertyVar.md index 6b14fca3..45a77a62 100644 --- a/test/data/format/propertyVar.md +++ b/test/data/format/propertyVar.md @@ -3,10 +3,6 @@ # x - -``` -var x: Int -``` - +`var x: Int` diff --git a/test/data/format/see.html b/test/data/format/see.html index 30409eb7..42e20e35 100644 --- a/test/data/format/see.html +++ b/test/data/format/see.html @@ -5,21 +5,24 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">quux</a><br/> <br/> <h1>quux</h1> -<pre><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></pre><br/> -<br/> +<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><br/> <strong>See Also</strong><br/> <p><a href="out.html">foo</a></p> <p><a href="out.html">bar</a></p> <br/> +<br/> +<br/> <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">foo</a><br/> <br/> <h1>foo</h1> -<pre><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></pre><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><br/> +<br/> <br/> <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">bar</a><br/> <br/> <h1>bar</h1> -<pre><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></pre><br/> +<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><br/> +<br/> <br/> </BODY> </HTML> diff --git a/test/data/format/throwsTag.md b/test/data/format/throwsTag.md index e6d0c76e..9f8b75c3 100644 --- a/test/data/format/throwsTag.md +++ b/test/data/format/throwsTag.md @@ -3,15 +3,11 @@ # f - -``` -fun f(): Unit -``` - - - +`fun f(): Unit` ### Exceptions `IllegalArgumentException` - on Mondays `NullPointerException` - on Tuesdays + + diff --git a/test/data/format/tripleBackticks.html b/test/data/format/tripleBackticks.html index ad4251a9..8cd378f0 100644 --- a/test/data/format/tripleBackticks.html +++ b/test/data/format/tripleBackticks.html @@ -6,13 +6,14 @@ <a href="out.html">test</a> / <a href="out.html"></a> / <a href="out.html">f</a><br/> <br/> <h1>f</h1> -<pre><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></pre><p>Description</p> -<br/> -<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><br/> +<p>Description</p> <h3>Description</h3> <pre><code> code sample </code></pre><br/> <br/> +<br/> +<br/> </BODY> </HTML> diff --git a/test/data/format/typeParameterBounds.md b/test/data/format/typeParameterBounds.md index f9d39e8c..1c779537 100644 --- a/test/data/format/typeParameterBounds.md +++ b/test/data/format/typeParameterBounds.md @@ -3,11 +3,7 @@ # generic - -``` -public fun <T : R, R> generic(): Unit -``` - +`public fun <T : R, R> generic(): Unit` generic function diff --git a/test/data/format/varargsFunction.md b/test/data/format/varargsFunction.md index c86132bc..04bb3d39 100644 --- a/test/data/format/varargsFunction.md +++ b/test/data/format/varargsFunction.md @@ -3,10 +3,6 @@ # f - -``` -fun f(vararg s: String): Unit -``` - +`fun f(vararg s: String): Unit` |