package org.jetbrains.dokka.tests import org.jetbrains.dokka.Content import org.jetbrains.dokka.DocumentationNode import org.junit.Test import kotlin.test.assertEquals import kotlin.test.assertTrue public class FunctionTest { @Test fun function() { verifyModel("test/data/functions/function.kt") { model -> with(model.members.single().members.single()) { assertEquals("fn", name) assertEquals(DocumentationNode.Kind.Function, kind) assertEquals("Function fn", content.summary.toTestString()) assertEquals("Unit", detail(DocumentationNode.Kind.Type).name) assertTrue(members.none()) assertTrue(links.none()) } } } @Test fun functionWithReceiver() { verifyModel("test/data/functions/functionWithReceiver.kt") { model -> with(model.members.single().members.single()) { assertEquals("String", name) assertEquals(DocumentationNode.Kind.ExternalClass, kind) assertEquals(2, members.count()) with(members[0]) { assertEquals("fn", name) assertEquals(DocumentationNode.Kind.Function, kind) assertEquals("Function with receiver", content.summary.toTestString()) assertEquals("public", details.elementAt(0).name) assertEquals("final", details.elementAt(1).name) with(details.elementAt(2)) { assertEquals("", name) assertEquals(DocumentationNode.Kind.Receiver, kind) assertEquals(Content.Empty, content) assertEquals("String", details.single().name) assertTrue(members.none()) assertTrue(links.none()) } assertEquals("Unit", details.elementAt(3).name) assertTrue(members.none()) assertTrue(links.none()) } with(members[1]) { assertEquals("fn", name) assertEquals(DocumentationNode.Kind.Function, kind) } } } } @Test fun genericFunction() { verifyModel("test/data/functions/genericFunction.kt") { model -> with(model.members.single().members.single()) { assertEquals("generic", name) assertEquals(DocumentationNode.Kind.Function, kind) assertEquals("generic function", content.summary.toTestString()) assertEquals("private", details.elementAt(0).name) assertEquals("final", details.elementAt(1).name) with(details.elementAt(2)) { assertEquals("T", name) assertEquals(DocumentationNode.Kind.TypeParameter, kind) assertEquals(Content.Empty, content) assertTrue(details.none()) assertTrue(members.none()) assertTrue(links.none()) } assertEquals("Unit", details.elementAt(3).name) assertTrue(members.none()) assertTrue(links.none()) } } } @Test fun genericFunctionWithConstraints() { verifyModel("test/data/functions/genericFunctionWithConstraints.kt") { model -> with(model.members.single().members.single()) { assertEquals("generic", name) assertEquals(DocumentationNode.Kind.Function, kind) assertEquals("generic function", content.summary.toTestString()) assertEquals("public", details.elementAt(0).name) assertEquals("final", details.elementAt(1).name) with(details.elementAt(2)) { assertEquals("T", name) assertEquals(DocumentationNode.Kind.TypeParameter, kind) assertEquals(Content.Empty, content) with(details.single()) { assertEquals("R", name) assertEquals(DocumentationNode.Kind.UpperBound, kind) assertEquals(Content.Empty, content) assertTrue(details.none()) assertTrue(members.none()) assertTrue(links.none()) } assertTrue(members.none()) assertTrue(links.none()) } with(details.elementAt(3)) { assertEquals("R", name) assertEquals(DocumentationNode.Kind.TypeParameter, kind) assertEquals(Content.Empty, content) assertTrue(members.none()) assertTrue(links.none()) } assertEquals("Unit", details.elementAt(4).name) assertTrue(members.none()) assertTrue(links.none()) } } } @Test fun functionWithParams() { verifyModel("test/data/functions/functionWithParams.kt") { model -> with(model.members.single().members.single()) { assertEquals("function", name) assertEquals(DocumentationNode.Kind.Function, kind) assertEquals("Multiline", content.summary.toTestString()) assertEquals("""Function Documentation""", content.description.toTestString()) assertEquals("public", details.elementAt(0).name) assertEquals("final", details.elementAt(1).name) with(details.elementAt(2)) { assertEquals("x", name) assertEquals(DocumentationNode.Kind.Parameter, kind) assertEquals("parameter", content.summary.toTestString()) assertEquals("Int", details.single().name) assertTrue(members.none()) assertTrue(links.none()) } assertEquals("Unit", details.elementAt(3).name) assertTrue(members.none()) assertTrue(links.none()) } } } @Test fun annotatedFunction() { verifyPackageMember("test/data/functions/annotatedFunction.kt", withKotlinRuntime = true) { func -> assertEquals(1, func.annotations.count()) with(func.annotations[0]) { assertEquals("Strictfp", name) assertEquals(Content.Empty, content) assertEquals(DocumentationNode.Kind.Annotation, kind) } } } @Test fun functionWithNotDocumentedAnnotation() { verifyPackageMember("test/data/functions/functionWithNotDocumentedAnnotation.kt") { func -> assertEquals(0, func.annotations.count()) } } @Test fun inlineFunction() { verifyPackageMember("test/data/functions/inlineFunction.kt") { func -> val modifiers = func.details(DocumentationNode.Kind.Modifier).map { it.name } assertTrue("inline" in modifiers) } } @Test fun functionWithAnnotatedParam() { verifyModel("test/data/functions/functionWithAnnotatedParam.kt") { model -> with(model.members.single().members.single { it.name == "function"} ) { with(details.elementAt(2)) { assertEquals(1, annotations.count()) with(annotations[0]) { assertEquals("Fancy", name) assertEquals(Content.Empty, content) assertEquals(DocumentationNode.Kind.Annotation, kind) } } } } } @Test fun functionWithNoinlineParam() { verifyPackageMember("test/data/functions/functionWithNoinlineParam.kt") { func -> with(func.details.elementAt(2)) { val modifiers = details(DocumentationNode.Kind.Modifier).map { it.name } assertTrue("noinline" in modifiers) } } } @Test fun annotatedFunctionWithAnnotationParameters() { verifyModel("test/data/functions/annotatedFunctionWithAnnotationParameters.kt") { model -> with(model.members.single().members.single { it.name == "f"}) { assertEquals(1, annotations.count()) with(annotations[0]) { assertEquals("Fancy", name) assertEquals(Content.Empty, content) assertEquals(DocumentationNode.Kind.Annotation, kind) assertEquals(1, details.count()) with(details[0]) { assertEquals(DocumentationNode.Kind.Parameter, kind) assertEquals(1, details.count()) with(details[0]) { assertEquals(DocumentationNode.Kind.Value, kind) assertEquals("1", name) } } } } } } @Test fun functionWithDefaultParameter() { verifyModel("test/data/functions/functionWithDefaultParameter.kt") { model -> with(model.members.single().members.single()) { with(details.elementAt(2)) { val value = details(DocumentationNode.Kind.Value) assertEquals(1, value.count()) with(value[0]) { assertEquals("\"\"", name) } } } } } }