aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Saveau <asaveau@google.com>2020-06-30 21:47:15 +0000
committerAlex Saveau <asaveau@google.com>2020-07-07 03:50:58 +0000
commit54c62ace5403f6b644152fbb67fb98dca5005ca4 (patch)
tree859b19a1f474b49692a3945f474b3da27cbf0f7b
parenta8a86f55b88b29bd4e2ec2141192733d9e12ac53 (diff)
downloaddokka-54c62ace5403f6b644152fbb67fb98dca5005ca4.tar.gz
Don't use fully qualified names in Dokka Javadoc
Bug: 149340317 Test: updated existing tests, ran ./gradlew test Change-Id: I1abe2886ff634ce38ff148565917d4305c891bc9
Diffstat
-rw-r--r--core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt3
-rw-r--r--core/src/test/kotlin/javadoc/JavadocTest.kt6
-rw-r--r--core/testdata/format/dac/deprecation/dac-as-java/Bar.html2
-rw-r--r--core/testdata/format/dac/deprecation/dac-as-java/DeprecatedBar.html2
-rw-r--r--core/testdata/format/dac/deprecation/dac-as-java/DeprecatedFoo.html2
-rw-r--r--core/testdata/format/dac/deprecation/dac-as-java/Foo.html2
-rw-r--r--core/testdata/format/dac/inheritedMethods/dac-as-java/Parent.html2
-rw-r--r--core/testdata/format/dac/javaClassLinks/dac-as-java/Bar.html14
-rw-r--r--core/testdata/format/dac/javaClassLinks/dac-as-java/Foo.html2
-rw-r--r--core/testdata/format/dac/javaConstructor/dac-as-java/Foo.html2
-rw-r--r--core/testdata/format/dac/javaDefaultConstructor/dac-as-java/Foo.html2
-rw-r--r--core/testdata/format/dac/javaMethodVisibilities/dac-as-java/Foo.html2
-rw-r--r--core/testdata/format/dac/javaSeeTag/dac-as-java/Bar.html2
-rw-r--r--core/testdata/format/dac/javaSeeTag/dac-as-java/Foo.html2
14 files changed, 23 insertions, 22 deletions
diff --git a/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt b/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
index ed4d36687..be989ad37 100644
--- a/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
+++ b/core/src/main/kotlin/Java/JavaPsiDocumentationBuilder.kt
@@ -29,12 +29,13 @@ fun getSignature(element: PsiElement?) = when(element) {
private fun PsiType.typeSignature(): String = when(this) {
is PsiArrayType -> "Array((${componentType.typeSignature()}))"
is PsiPrimitiveType -> "kotlin." + canonicalText.capitalize()
+ is PsiClassType -> resolve()?.qualifiedName ?: className
else -> mapTypeName(this)
}
private fun mapTypeName(psiType: PsiType): String = when (psiType) {
is PsiPrimitiveType -> psiType.canonicalText
- is PsiClassType -> psiType.resolve()?.qualifiedName ?: psiType.className
+ is PsiClassType -> psiType.resolve()?.name ?: psiType.className
is PsiEllipsisType -> mapTypeName(psiType.componentType)
is PsiArrayType -> "kotlin.Array"
else -> psiType.canonicalText
diff --git a/core/src/test/kotlin/javadoc/JavadocTest.kt b/core/src/test/kotlin/javadoc/JavadocTest.kt
index 74265cbb8..a42d63933 100644
--- a/core/src/test/kotlin/javadoc/JavadocTest.kt
+++ b/core/src/test/kotlin/javadoc/JavadocTest.kt
@@ -16,8 +16,8 @@ class JavadocTest {
val type = method.returnType()
assertFalse(type.asClassDoc().isIncluded)
- assertEquals("java.lang.String", type.qualifiedTypeName())
- assertEquals("java.lang.String", type.asClassDoc().qualifiedName())
+ assertEquals("String", type.qualifiedTypeName())
+ assertEquals("String", type.asClassDoc().qualifiedName())
val params = method.parameters()
assertTrue(params[0].type().isPrimitive)
@@ -119,7 +119,7 @@ class JavadocTest {
val methodParamType = doc.classNamed("TypealiasesKt")!!.methods()
.find { it.name() == "some" }!!.parameters().first()
.type()
- assertEquals("kotlin.jvm.functions.Function1", methodParamType.qualifiedTypeName())
+ assertEquals("Function1", methodParamType.qualifiedTypeName())
assertEquals("? super A, C", methodParamType.asParameterizedType().typeArguments()
.map(Type::qualifiedTypeName).joinToString())
}
diff --git a/core/testdata/format/dac/deprecation/dac-as-java/Bar.html b/core/testdata/format/dac/deprecation/dac-as-java/Bar.html
index d77fa9e64..68d559ab0 100644
--- a/core/testdata/format/dac/deprecation/dac-as-java/Bar.html
+++ b/core/testdata/format/dac/deprecation/dac-as-java/Bar.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Bar</h1>
- <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Bar</a></td>
diff --git a/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedBar.html b/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedBar.html
index 56283f6e5..c5fe8492b 100644
--- a/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedBar.html
+++ b/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedBar.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>DeprecatedBar</h1>
- <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">DeprecatedBar</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">DeprecatedBar</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">DeprecatedBar</a></td>
diff --git a/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedFoo.html b/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedFoo.html
index e7e2fecb0..360b24ef3 100644
--- a/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedFoo.html
+++ b/core/testdata/format/dac/deprecation/dac-as-java/DeprecatedFoo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>DeprecatedFoo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">DeprecatedFoo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">DeprecatedFoo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">DeprecatedFoo</a></td>
diff --git a/core/testdata/format/dac/deprecation/dac-as-java/Foo.html b/core/testdata/format/dac/deprecation/dac-as-java/Foo.html
index c898800da..b468e4daa 100644
--- a/core/testdata/format/dac/deprecation/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/deprecation/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
diff --git a/core/testdata/format/dac/inheritedMethods/dac-as-java/Parent.html b/core/testdata/format/dac/inheritedMethods/dac-as-java/Parent.html
index dd305f7f8..977e693d8 100644
--- a/core/testdata/format/dac/inheritedMethods/dac-as-java/Parent.html
+++ b/core/testdata/format/dac/inheritedMethods/dac-as-java/Parent.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Parent</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Parent</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Parent</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Parent</a></td>
diff --git a/core/testdata/format/dac/javaClassLinks/dac-as-java/Bar.html b/core/testdata/format/dac/javaClassLinks/dac-as-java/Bar.html
index cbabc2920..64d0c4cd8 100644
--- a/core/testdata/format/dac/javaClassLinks/dac-as-java/Bar.html
+++ b/core/testdata/format/dac/javaClassLinks/dac-as-java/Bar.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Bar</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Bar</a></td>
@@ -40,9 +40,9 @@
</td>
</tr>
<tr>
- <td><a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">java.util.ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">java.lang.String</span><span class="symbol">&gt;</span></td>
+ <td><a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">&gt;</span></td>
<td>
- <div><code><a href="#getMyList(java.util.HashSet)">getMyList</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">java.util.HashSet</span></a> <span class="identifier">input</span>)</code></div>
+ <div><code><a href="#getMyList(HashSet)">getMyList</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">HashSet</span></a> <span class="identifier">input</span>)</code></div>
<p></p>
</td>
</tr>
@@ -100,10 +100,10 @@
</tbody>
</table>
</div>
-<a name="getMyList(java.util.HashSet)"></a>
+<a name="getMyList(HashSet)"></a>
<div class="api apilevel-" data-version-added="">
<h3 class="api-name">getMyList</h3>
- <pre class="api-signature no-pretty-print"><span class="keyword">public</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">java.util.ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">java.lang.String</span><span class="symbol">&gt;</span> <span class="identifier">getMyList</span><span class="symbol">(</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">java.util.HashSet</span></a> <span class="identifier">input</span><span class="symbol">)</span></pre>
+ <pre class="api-signature no-pretty-print"><span class="keyword">public</span> <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">&gt;</span> <span class="identifier">getMyList</span><span class="symbol">(</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">HashSet</span></a> <span class="identifier">input</span><span class="symbol">)</span></pre>
<table class="responsive">
<tbody>
<tr>
@@ -111,7 +111,7 @@
</tr>
<tr>
<td><code>input</code></td>
- <td><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">java.util.HashSet</span></a><span class="symbol">:</span> The best set you can afford.</td>
+ <td><a href="http://docs.oracle.com/javase/6/docs/api/java/util/HashSet.html"><span class="identifier">HashSet</span></a><span class="symbol">:</span> The best set you can afford.</td>
</tr>
</tbody>
</table>
@@ -121,7 +121,7 @@
<th colspan="2">Return</th>
</tr>
<tr>
- <td><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">java.util.ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">java.lang.String</span><span class="symbol">&gt;</span></code></td>
+ <td><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html"><span class="identifier">ArrayList</span></a><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">&gt;</span></code></td>
<td></td>
</tr>
</tbody>
diff --git a/core/testdata/format/dac/javaClassLinks/dac-as-java/Foo.html b/core/testdata/format/dac/javaClassLinks/dac-as-java/Foo.html
index 0ae4d255b..bddb7ff8a 100644
--- a/core/testdata/format/dac/javaClassLinks/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/javaClassLinks/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
diff --git a/core/testdata/format/dac/javaConstructor/dac-as-java/Foo.html b/core/testdata/format/dac/javaConstructor/dac-as-java/Foo.html
index 0ae4d255b..bddb7ff8a 100644
--- a/core/testdata/format/dac/javaConstructor/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/javaConstructor/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
diff --git a/core/testdata/format/dac/javaDefaultConstructor/dac-as-java/Foo.html b/core/testdata/format/dac/javaDefaultConstructor/dac-as-java/Foo.html
index 0ae4d255b..bddb7ff8a 100644
--- a/core/testdata/format/dac/javaDefaultConstructor/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/javaDefaultConstructor/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
diff --git a/core/testdata/format/dac/javaMethodVisibilities/dac-as-java/Foo.html b/core/testdata/format/dac/javaMethodVisibilities/dac-as-java/Foo.html
index 1ed04c547..978b1071d 100644
--- a/core/testdata/format/dac/javaMethodVisibilities/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/javaMethodVisibilities/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
diff --git a/core/testdata/format/dac/javaSeeTag/dac-as-java/Bar.html b/core/testdata/format/dac/javaSeeTag/dac-as-java/Bar.html
index 6b4d75f4a..7eb3cdf85 100644
--- a/core/testdata/format/dac/javaSeeTag/dac-as-java/Bar.html
+++ b/core/testdata/format/dac/javaSeeTag/dac-as-java/Bar.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Bar</h1>
- <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class</span> <span class="identifier">Bar</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Bar</a></td>
diff --git a/core/testdata/format/dac/javaSeeTag/dac-as-java/Foo.html b/core/testdata/format/dac/javaSeeTag/dac-as-java/Foo.html
index b9f23dc59..4529fd04d 100644
--- a/core/testdata/format/dac/javaSeeTag/dac-as-java/Foo.html
+++ b/core/testdata/format/dac/javaSeeTag/dac-as-java/Foo.html
@@ -7,7 +7,7 @@
<body>
<div id="api-info-block"></div>
<h1>Foo</h1>
- <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">java.lang.Object</span></pre>
+ <pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">Foo</span> <span class="keyword">implements</span> <span class="identifier">Object</span></pre>
<table class="jd-inheritance-table">
<tr>
<td class="jd-inheritance-class-cell" colSpan="1"><a href="#">Foo</a></td>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-04 22:56:59 +0000