From ebbf265dbe9d5fe37e56c9baa567edaf21dd16fa Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Tue, 10 Feb 2015 19:35:27 +0100 Subject: much nicer html output for overloads --- test/data/format/accessor.get.md | 6 +----- test/data/format/accessor.set.md | 6 +----- test/data/format/annotationClass.md | 6 +----- test/data/format/annotationParams.md | 6 +----- test/data/format/annotations.md | 6 +----- test/data/format/brokenLink.html | 3 ++- test/data/format/classWithClassObject.html | 3 ++- test/data/format/classWithClassObject.md | 6 +----- test/data/format/codeSpan.html | 3 ++- test/data/format/deprecated.class.html | 9 ++++++--- test/data/format/deprecated.package.html | 3 ++- test/data/format/emptyDescription.md | 6 +----- test/data/format/enumClass.md | 6 +----- test/data/format/enumClass.value.md | 6 +----- test/data/format/extensions.package.md | 6 +----- test/data/format/functionWithDefaultParameter.md | 6 +----- test/data/format/htmlEscaping.html | 3 ++- test/data/format/overloads.html | 3 ++- test/data/format/overloadsWithDescription.html | 8 +++++--- test/data/format/overloadsWithDifferentDescriptions.html | 10 ++++++---- test/data/format/overridingFunction.md | 6 +----- test/data/format/paramTag.md | 10 +++------- test/data/format/parenthesis.html | 3 ++- test/data/format/propertyVar.md | 6 +----- test/data/format/see.html | 11 +++++++---- test/data/format/throwsTag.md | 10 +++------- test/data/format/tripleBackticks.html | 7 ++++--- test/data/format/typeParameterBounds.md | 6 +----- test/data/format/varargsFunction.md | 6 +----- 29 files changed, 63 insertions(+), 113 deletions(-) (limited to 'test/data') 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 @@ test /  / f

f

-
fun f(): Unit

This references noSuchIdentifier.

+fun f(): Unit
+

This references noSuchIdentifier.



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 @@ test /  / Klass

Klass

-
class Klass

+class Klass
+

Constructors

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 @@ test /  / foo

foo

-
fun foo(): Unit

This is a code span.

+fun foo(): Unit
+

This is a code span.



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 @@ test /  / C

C

-
class C
Deprecated: This class sucks
+class C
+Deprecated: This class sucks


test /  / f

f

-
fun f(): Unit
Deprecated: This function sucks
+fun f(): Unit
+Deprecated: This function sucks


test /  / p

p

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


Constructors

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 @@ test / 

-
package

+package
+

Types

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 @@ test /  / x

x

-
fun <T> x(): T?

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

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

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



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 @@ test / 

-
package

+package
+

Functions

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 @@ test /  / f

f

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

Performs an action on x.

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

Performs an action on x.

Description

This is a long description.



Parameters

x - the value to perform the action on.
+
+
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 @@ test /  / f

f

-
fun f(x: Int): Unit

Performs an action on x.

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

Performs an action on x.

Description

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.



+fun f(x: String): Unit
+

Performs an action on x.

Description

This is a long description.



Parameters

x - the string value to perform the action on.
+
+
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 @@ test /  / foo

foo

-
fun foo(): Unit

foo (bar)

+fun foo(): Unit
+

foo (bar)



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 @@ test /  / quux

quux

-
fun quux(): Unit

-
+fun quux(): Unit
See Also

foo

bar


+
+
test /  / foo

foo

-
fun foo(): Unit

+fun foo(): Unit
+

test /  / bar

bar

-
fun bar(): Unit

+fun bar(): Unit
+

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 @@ test /  / f

f

-
fun f(): Unit

Description

-
-
+fun f(): Unit
+

Description

Description


 code sample


+
+
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` -- cgit