From f45750699d089e0101dcde5d38c7e08ec2f03708 Mon Sep 17 00:00:00 2001 From: irina-turova <31963497+irina-turova@users.noreply.github.com> Date: Wed, 31 May 2023 16:16:10 +0500 Subject: [PATCH] Add support for `@author`, `@since`, `@return` Javadoc tags (#2967) --- .../translators/psi/parsers/JavadocParser.kt | 9 ++ .../translators/psi/parsers/JavadocTag.kt | 2 +- plugins/javadoc/api/javadoc.api | 24 +++-- .../dokka/javadoc/JavadocPageCreator.kt | 32 +++++- .../dokka/javadoc/pages/JavadocPageNodes.kt | 13 +++ .../JavadocContentToTemplateMapTranslator.kt | 4 + .../main/resources/static_res/stylesheet.css | 10 +- .../src/main/resources/views/class.korte | 38 ++++++- .../JavadocClasslikeTemplateMapTest.kt | 98 +++++++++++++++++++ 9 files changed, 210 insertions(+), 20 deletions(-) diff --git a/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt b/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt index 4af8c7908a..59c6f7027d 100644 --- a/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt +++ b/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt @@ -168,6 +168,15 @@ class JavadocParser( ) ) + JavadocTag.SINCE -> Since( + wrapTagIfNecessary( + convertJavadocElements( + tag.contentElementsWithSiblingIfNeeded(), + context = resolutionContext + ) + ) + ) + else -> emptyTagWrapper(tag, docComment) } } diff --git a/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocTag.kt b/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocTag.kt index 747e2efee7..5b3be7e33a 100644 --- a/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocTag.kt +++ b/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocTag.kt @@ -1,7 +1,7 @@ package org.jetbrains.dokka.base.translators.psi.parsers internal enum class JavadocTag { - PARAM, THROWS, RETURN, AUTHOR, SEE, DEPRECATED, EXCEPTION, HIDE, + PARAM, THROWS, RETURN, AUTHOR, SEE, DEPRECATED, EXCEPTION, HIDE, SINCE, /** * Artificial tag created to handle tag-less section diff --git a/plugins/javadoc/api/javadoc.api b/plugins/javadoc/api/javadoc.api index e98007e294..4d07788220 100644 --- a/plugins/javadoc/api/javadoc.api +++ b/plugins/javadoc/api/javadoc.api @@ -178,10 +178,11 @@ public final class org/jetbrains/dokka/javadoc/pages/JavaContentGroupBuilder { } public final class org/jetbrains/dokka/javadoc/pages/JavadocClasslikePageNode : org/jetbrains/dokka/javadoc/pages/JavadocPageNode, org/jetbrains/dokka/javadoc/pages/NavigableJavadocNode, org/jetbrains/dokka/javadoc/pages/WithBrief, org/jetbrains/dokka/javadoc/pages/WithJavadocExtra, org/jetbrains/dokka/javadoc/pages/WithNavigable, org/jetbrains/dokka/pages/ClasslikePage { - public fun (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V - public synthetic fun (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V + public synthetic fun (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun getAllNavigables ()Ljava/util/List; public final fun getAnchorables ()Ljava/util/List; + public final fun getAuthorTagContent ()Ljava/util/List; public fun getBrief ()Ljava/util/List; public fun getChildren ()Ljava/util/List; public final fun getClasslikes ()Ljava/util/List; @@ -203,6 +204,7 @@ public final class org/jetbrains/dokka/javadoc/pages/JavadocClasslikePageNode : public final fun getPackageName ()Ljava/lang/String; public final fun getProperties ()Ljava/util/List; public final fun getSignature ()Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode; + public final fun getSinceTagContent ()Ljava/util/List; public fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/PageNode; public fun modified (Ljava/lang/String;Lorg/jetbrains/dokka/pages/ContentNode;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)Lorg/jetbrains/dokka/pages/ContentPage; public synthetic fun withNewExtras (Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Ljava/lang/Object; @@ -293,17 +295,19 @@ public final class org/jetbrains/dokka/javadoc/pages/JavadocEntryNode : org/jetb } public final class org/jetbrains/dokka/javadoc/pages/JavadocFunctionNode : org/jetbrains/dokka/javadoc/pages/AnchorableJavadocNode, org/jetbrains/dokka/javadoc/pages/WithBrief, org/jetbrains/dokka/javadoc/pages/WithJavadocExtra { - public fun (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V - public synthetic fun (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V + public synthetic fun (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode; public final fun component2 ()Ljava/util/List; public final fun component3 ()Ljava/util/List; public final fun component4 ()Ljava/util/List; - public final fun component5 ()Ljava/lang/String; - public final fun component6 ()Lorg/jetbrains/dokka/links/DRI; - public final fun component7 ()Lorg/jetbrains/dokka/model/properties/PropertyContainer; - public final fun copy (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode; - public static synthetic fun copy$default (Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILjava/lang/Object;)Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode; + public final fun component5 ()Ljava/util/List; + public final fun component6 ()Ljava/util/List; + public final fun component7 ()Ljava/lang/String; + public final fun component8 ()Lorg/jetbrains/dokka/links/DRI; + public final fun component9 ()Lorg/jetbrains/dokka/model/properties/PropertyContainer; + public final fun copy (Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode; + public static synthetic fun copy$default (Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILjava/lang/Object;)Lorg/jetbrains/dokka/javadoc/pages/JavadocFunctionNode; public fun equals (Ljava/lang/Object;)Z public fun getBrief ()Ljava/util/List; public final fun getDescription ()Ljava/util/List; @@ -311,7 +315,9 @@ public final class org/jetbrains/dokka/javadoc/pages/JavadocFunctionNode : org/j public fun getExtra ()Lorg/jetbrains/dokka/model/properties/PropertyContainer; public fun getName ()Ljava/lang/String; public final fun getParameters ()Ljava/util/List; + public final fun getReturnTagContent ()Ljava/util/List; public final fun getSignature ()Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode; + public final fun getSinceTagContent ()Ljava/util/List; public fun hashCode ()I public final fun isInherited ()Z public fun toString ()Ljava/lang/String; diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt index 8081410317..616583c808 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt @@ -7,10 +7,7 @@ import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConve import org.jetbrains.dokka.base.translators.documentables.firstSentenceBriefFromContentNodes import org.jetbrains.dokka.javadoc.pages.* import org.jetbrains.dokka.model.* -import org.jetbrains.dokka.model.doc.Description -import org.jetbrains.dokka.model.doc.Index -import org.jetbrains.dokka.model.doc.Param -import org.jetbrains.dokka.model.doc.TagWrapper +import org.jetbrains.dokka.model.doc.* import org.jetbrains.dokka.model.properties.PropertyContainer import org.jetbrains.dokka.model.properties.WithExtraProperties import org.jetbrains.dokka.pages.* @@ -68,9 +65,11 @@ open class JavadocPageCreator(context: DokkaContext) { it.name, signatureForNode(it, jvm), it.descriptionToContentNodes(jvm), - PropertyContainer.withAll(it.indexesInDocumentation()) + PropertyContainer.withAll(it.indexesInDocumentation()), ) }, + sinceTagContent = c.sinceToContentNodes(jvm), + authorTagContent = c.authorsToContentNodes(jvm), documentables = listOf(c), children = children, extra = extra + c.indexesInDocumentation() @@ -165,6 +164,8 @@ open class JavadocPageCreator(context: DokkaContext) { ) } }, + returnTagContent = returnToContentNodes(jvm), + sinceTagContent = sinceToContentNodes(jvm), extra = extra + indexesInDocumentation() ) } @@ -177,6 +178,9 @@ open class JavadocPageCreator(context: DokkaContext) { private inline fun Documentable.findNodeInDocumentation(sourceSetData: DokkaSourceSet?): T? = documentation[sourceSetData]?.firstChildOfTypeOrNull() + private inline fun Documentable.findAllNodesInDocumentation(sourceSetData: DokkaSourceSet?): List = + documentation[sourceSetData]?.childrenOfType() ?: emptyList() + private fun Documentable.descriptionToContentNodes(sourceSet: DokkaSourceSet? = highestJvmSourceSet) = contentNodesFromType(sourceSet) @@ -192,6 +196,15 @@ open class JavadocPageCreator(context: DokkaContext) { ) }.orEmpty() + private inline fun Documentable.allContentNodesFromType(sourceSet: DokkaSourceSet?) = + findAllNodesInDocumentation(sourceSet).map { + DocTagToContentConverter().buildContent( + it.root, + DCI(setOf(dri), JavadocContentKind.OverviewSummary), + sourceSets.toSet() + ) + } + fun List.nodeForJvm(jvm: DokkaSourceSet): ContentNode = firstOrNull { jvm.sourceSetID in it.sourceSets.sourceSetIDs } ?: throw IllegalStateException("No source set found for ${jvm.sourceSetID} ") @@ -228,5 +241,14 @@ open class JavadocPageCreator(context: DokkaContext) { } ) } + + private fun Documentable.authorsToContentNodes(sourceSet: DokkaSourceSet? = highestJvmSourceSet) = + allContentNodesFromType(sourceSet) + + private fun Documentable.sinceToContentNodes(sourceSet: DokkaSourceSet? = highestJvmSourceSet) = + allContentNodesFromType(sourceSet) + + private fun Documentable.returnToContentNodes(sourceSet: DokkaSourceSet? = highestJvmSourceSet) = + contentNodesFromType(sourceSet) } diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt index cafc6c3e51..8210b30af6 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt @@ -149,6 +149,7 @@ data class JavadocPropertyNode( override val name: String, val signature: JavadocSignatureContentNode, override val brief: List, + override val extra: PropertyContainer = PropertyContainer.empty() ) : AnchorableJavadocNode(name, dri), WithJavadocExtra, WithBrief @@ -157,6 +158,10 @@ data class JavadocFunctionNode( override val brief: List, val description: List, val parameters: List, + + val returnTagContent: List, + val sinceTagContent: List>, + override val name: String, override val dri: DRI, override val extra: PropertyContainer = PropertyContainer.empty() @@ -182,6 +187,10 @@ class JavadocClasslikePageNode( val classlikes: List, val properties: List, override val brief: List, + + val sinceTagContent: List>, + val authorTagContent: List>, + override val documentables: List = emptyList(), override val children: List = emptyList(), override val embeddedResources: List = listOf(), @@ -215,6 +224,8 @@ class JavadocClasslikePageNode( classlikes, properties, brief, + sinceTagContent, + authorTagContent, documentables, children, embeddedResources, @@ -240,6 +251,8 @@ class JavadocClasslikePageNode( classlikes, properties, brief, + sinceTagContent, + authorTagContent, documentables, children, embeddedResources, diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt index 45fa3f2e82..6a590bc712 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt @@ -122,6 +122,8 @@ internal class JavadocContentToTemplateMapTranslator( "description" to htmlForContentNodes(node.description,contextNode), "parameters" to node.parameters.map { templateMapForParameterNode(it) }, "inlineParameters" to node.parameters.joinToString { renderInlineParameter(it) }, + "returnTagContent" to htmlForContentNodes(node.returnTagContent, contextNode), + "sinceTagContent" to node.sinceTagContent.map { htmlForContentNodes(it, contextNode) }, "anchorLink" to node.getAnchor(), "signature" to templateMapForSignatureNode(node.signature), "name" to node.name @@ -137,6 +139,8 @@ internal class JavadocContentToTemplateMapTranslator( "properties" to node.properties.map { templateMapForPropertyNode(it) }, "classlikes" to node.classlikes.map { templateMapForNestedClasslikeNode(it) }, "implementedInterfaces" to templateMapForImplementedInterfaces(node).sorted(), + "sinceTagContent" to node.sinceTagContent.map { htmlForContentNodes(it, contextNode) }, + "authorTagContent" to node.authorTagContent.map { htmlForContentNodes(it, contextNode) }, "kind" to node.kind, "packageName" to node.packageName, "name" to node.name diff --git a/plugins/javadoc/src/main/resources/static_res/stylesheet.css b/plugins/javadoc/src/main/resources/static_res/stylesheet.css index e46e2825f3..5d5bc20ae8 100644 --- a/plugins/javadoc/src/main/resources/static_res/stylesheet.css +++ b/plugins/javadoc/src/main/resources/static_res/stylesheet.css @@ -352,6 +352,12 @@ ul.blockList li.blockList h2 { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } + +.contentContainer .description dl dt p, .contentContainer .details dl dt p, .serializedFormContainer dl dt p, +.contentContainer .description dl dd p, .contentContainer .details dl dd p, .serializedFormContainer dl dd p { + margin:5px 0 10px 0px; +} + .serializedFormContainer dl.nameValue dt { margin-left:1px; font-size:1.1em; @@ -629,8 +635,8 @@ h1.hidden { } .deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, .moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, -.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, -.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { +.packageHierarchyLabel, .authorLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .sinceLabel, .typeNameLabel, .typeNameLink, .searchTagLink { font-weight:bold; } .deprecationComment, .emphasizedPhrase, .interfaceName { diff --git a/plugins/javadoc/src/main/resources/views/class.korte b/plugins/javadoc/src/main/resources/views/class.korte index 84e302fb98..54106dda2d 100644 --- a/plugins/javadoc/src/main/resources/views/class.korte +++ b/plugins/javadoc/src/main/resources/views/class.korte @@ -38,6 +38,24 @@ {% if signature.supertypes != null %}{{signature.supertypes|raw}}{% endif %}
{{ classlikeDocumentation|raw }}
+ +
+ + {% if sinceTagContent.size() != 0 %} +
Since:
+ {% for since in sinceTagContent %} +
{{ since|raw }}
+ {% endfor %} + {% endif %} + + {% if authorTagContent.size() != 0 %} +
Author:
+ {% for author in authorTagContent %} +
{{ author|raw }}
+ {% endfor %} + {% endif %} + +
@@ -271,17 +289,31 @@

{{ method.name }}

{{ method.signature.annotations|raw }} {{ method.signature.modifiers|raw }} {{ method.signature.signatureWithoutModifiers|raw}}
{{ method.description|raw }}
- {% if method.parameters.size != 0 && hasAnyDescription(method.parameters) %} +
+ + {% if method.parameters.size != 0 && hasAnyDescription(method.parameters) %}
Parameters:
{% for parameter in method.parameters %} {% if parameter.description != "" %}
{{ parameter.name }} - {{ parameter.description|raw }}
{% endif %} {% endfor %} -
{% endif %} - + + {% if method.returnTagContent != "" %} +
Returns:
+
{{ method.returnTagContent|raw }}
+ {% endif %} + + {% if method.sinceTagContent.size() != 0 %} +
Since:
+ {% for since in method.sinceTagContent %} +
{{ since|raw }}
+ {% endfor %} + {% endif %} + + {% endfor %} diff --git a/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt b/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt index 65fbd30f3d..53167f71b2 100644 --- a/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt +++ b/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt @@ -342,6 +342,104 @@ internal class JavadocClasslikeTemplateMapTest : AbstractJavadocTemplateMapTest( } } + @Test + fun `@author @since @return method tags`(){ + dualTestTemplateMapInline( + kotlin = + """ + /src/source0.kt + package com.test.package0 + class TestClass { + /** + * Testing @author @since @return method tags + * @since 1.2 + * @since 08 april 2023 + * @return parameter's value in lower case + */ + fun testFunction(testParam: String?): String { + return testParam?.lowercase() ?: "" + } + } + """, + java = + """ + /src/com/test/package0/TestClass.java + package com.test.package0; + public final class TestClass { + /** + * Testing @author @since @return method tags + * @since 1.2 + * @since 08 april 2023 + * @return parameter's value in lower case + */ + public final String testFunction(String testParam) { + return testParam.toLowerCase(); + } + } + """ + ) { + val map = singlePageOfType().templateMap + assertEquals("TestClass", map["name"]) + + val methods = assertIsInstance>(map["methods"]) + val testFunction = assertIsInstance>>(methods["own"]).single() + assertEquals("Testing @author @since @return method tags", testFunction["brief"]) + + assertEquals("testFunction", testFunction["name"]) + assertEquals(listOf("

1.2

", "

08 april 2023

"), testFunction["sinceTagContent"]) + assertEquals("

parameter's value in lower case

", testFunction["returnTagContent"]) + } + } + + @Test + fun `@author @since class tags`(){ + dualTestTemplateMapInline( + kotlin = + """ + /src/source0.kt + package com.test.package0 + /** + * Testing @author @since class tags + * @author Test Author + * @author Test Author2 + * @author Test Author3 + * @since 1.2 + * @since 08 april 2023 + */ + class TestClass { + fun testFunction(testParam: String?): String { + return testParam?.lowercase() ?: "" + } + } + """, + java = + """ + /src/com/test/package0/TestClass.java + package com.test.package0; + /** + * Testing @author @since class tags + * @author Test Author + * @author Test Author2 + * @author Test Author3 + * @since 1.2 + * @since 08 april 2023 + */ + public final class TestClass { + public final String testFunction(String testParam) { + return testParam.toLowerCase(); + } + } + """ + ) { + val map = singlePageOfType().templateMap + + assertEquals("TestClass", map["name"]) + assertEquals("

Testing @author @since class tags

", map["classlikeDocumentation"]) + assertEquals(listOf("

Test Author

", "

Test Author2

", "

Test Author3

"), map["authorTagContent"]) + assertEquals(listOf("

1.2

", "

08 april 2023

"), map["sinceTagContent"]) + } + } + private fun assertParameterNode(node: Map, expectedName: String, expectedType: String, expectedDescription: String){ assertEquals(expectedName, node["name"]) assertEquals(expectedType, node["type"])