Allow linking arguments with methods, change link label (#431)

* Add PsiParameter to link arguments with methods, change link label

5 files changed, 32 insertions, 3 deletions

diff --git a/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt b/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
index f0b3a56b..1ef601d3 100644
--- a/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
+++ b/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
@@ -20,11 +20,19 @@ fun getSignature(element: PsiElement?) = when(element) {
     is PsiClass -> element.qualifiedName
     is PsiField -> element.containingClass!!.qualifiedName + "$" + element.name
     is PsiMethod ->
-        element.containingClass!!.qualifiedName + "$" + element.name + "(" +
-                element.parameterList.parameters.map { it.type.typeSignature() }.joinToString(",") + ")"
+        methodSignature(element)
+    is PsiParameter -> {
+        val method = (element.parent.parent as PsiMethod)
+        methodSignature(method)
+    }
     else -> null
 }
 
+private fun methodSignature(method: PsiMethod): String {
+    return method.containingClass!!.qualifiedName + "$" + method.name + "(" +
+            method.parameterList.parameters.map { it.type.typeSignature() }.joinToString(",") + ")"
+}
+
 private fun PsiType.typeSignature(): String = when(this) {
     is PsiArrayType -> "Array((${componentType.typeSignature()}))"
     is PsiPrimitiveType -> "kotlin." + canonicalText.capitalize()
diff --git a/core/src/main/kotlin/Model/Content.kt b/core/src/main/kotlin/Model/Content.kt
index 87a8023a..c142f4a4 100644
--- a/core/src/main/kotlin/Model/Content.kt
+++ b/core/src/main/kotlin/Model/Content.kt
@@ -115,6 +115,7 @@ class ContentBlockSampleCode(language: String = "kotlin", val importsBlock: Cont
 
 abstract class ContentNodeLink() : ContentBlock() {
     abstract val node: DocumentationNode?
+    abstract val text: String?
 }
 
 object ContentHardLineBreak : ContentNode {
@@ -128,6 +129,8 @@ class ContentNodeDirectLink(override val node: DocumentationNode): ContentNodeLi
 
     override fun hashCode(): Int =
             children.hashCode() * 31 + node.name.hashCode()
+
+    override val text: String? = null
 }
 
 class ContentNodeLazyLink(val linkText: String, val lazyNode: () -> DocumentationNode?): ContentNodeLink() {
@@ -138,6 +141,8 @@ class ContentNodeLazyLink(val linkText: String, val lazyNode: () -> Documentatio
 
     override fun hashCode(): Int =
             children.hashCode() * 31 + linkText.hashCode()
+
+    override val text: String? = linkText
 }
 
 class ContentExternalLink(val href : String) : ContentBlock() {
diff --git a/core/src/main/kotlin/javadoc/tags.kt b/core/src/main/kotlin/javadoc/tags.kt
index 05d98b71..99c9bfff 100644
--- a/core/src/main/kotlin/javadoc/tags.kt
+++ b/core/src/main/kotlin/javadoc/tags.kt
@@ -71,7 +71,7 @@ class SeeMethodTagAdapter(holder: Doc, val method: MethodAdapter, content: Conte
     override fun referencedPackage(): PackageDoc? = null
     override fun referencedClass(): ClassDoc? = method.containingClass()
     override fun referencedClassName(): String = method.containingClass()?.name() ?: ""
-    override fun label(): String = "${method.containingClass()?.name()}.${method.name()}"
+    override fun label(): String = content.text ?: "${method.containingClass()?.name()}.${method.name()}"
 
     override fun inlineTags(): Array<out Tag> = emptyArray() // TODO
     override fun firstSentenceTags(): Array<out Tag> = inlineTags() // TODO
diff --git a/core/src/test/kotlin/javadoc/JavadocTest.kt b/core/src/test/kotlin/javadoc/JavadocTest.kt
index 3e5b5ff8..6adbe7a0 100644
--- a/core/src/test/kotlin/javadoc/JavadocTest.kt
+++ b/core/src/test/kotlin/javadoc/JavadocTest.kt
@@ -259,6 +259,18 @@ class JavadocTest {
         }
     }
 
+    @Test
+    fun testArgumentReference() {
+        verifyJavadoc("testdata/javadoc/argumentReference.kt") { doc ->
+            val classDoc = doc.classNamed("ArgumentReferenceKt")!!
+            val method = classDoc.methods().first()
+            val tag = method.seeTags().first()
+            assertEquals("argNamedError", tag.referencedMemberName())
+            assertEquals("error", tag.label())
+        }
+    }
+
+
     private fun verifyJavadoc(name: String,
                               withJdk: Boolean = false,
                               withKotlinRuntime: Boolean = false,
diff --git a/core/testdata/javadoc/argumentReference.kt b/core/testdata/javadoc/argumentReference.kt
new file mode 100644
index 00000000..ac3104e9
--- /dev/null
+++ b/core/testdata/javadoc/argumentReference.kt
@@ -0,0 +1,4 @@
+/**
+ * [error]
+ */
+fun argNamedError(error: String) {}
\ No newline at end of file