diff options
author | Dmitry Jemerov <intelliyole@gmail.com> | 2015-07-27 15:13:11 +0200 |
---|---|---|
committer | Dmitry Jemerov <intelliyole@gmail.com> | 2015-07-27 15:13:11 +0200 |
commit | befbe69c3863b1048b585e795ec2f99d5a10390e (patch) | |
tree | d2392c9a9fafbd5b2e7b9c5c35c593fd73d59d0d | |
parent | 28a3891ffa2c4984a9d49be41d76fe97854872c9 (diff) | |
parent | 2930cd9685c5e6296b24e9530b296c7ce3ea89fa (diff) | |
download | dokka-befbe69c3863b1048b585e795ec2f99d5a10390e.tar.gz dokka-befbe69c3863b1048b585e795ec2f99d5a10390e.tar.bz2 dokka-befbe69c3863b1048b585e795ec2f99d5a10390e.zip |
Merge pull request #31 from cy6erGn0m/javadoc
Kotlin upgrade + source position in documentation node
-rw-r--r-- | dokka-fatjar/build.gradle | 2 | ||||
-rw-r--r-- | lib/kotlin-for-upsource.jar | bin | 13795854 -> 14136706 bytes | |||
-rw-r--r-- | lib/markdown.jar | bin | 239956 -> 239909 bytes | |||
-rw-r--r-- | src/Kotlin/DocumentationBuilder.kt | 21 | ||||
-rw-r--r-- | src/Languages/JavaLanguageService.kt | 4 | ||||
-rw-r--r-- | src/Model/DocumentationNode.kt | 1 | ||||
-rw-r--r-- | src/Model/SourceLinks.kt | 38 |
7 files changed, 49 insertions, 17 deletions
diff --git a/dokka-fatjar/build.gradle b/dokka-fatjar/build.gradle index e7c9cd97..ffec3b82 100644 --- a/dokka-fatjar/build.gradle +++ b/dokka-fatjar/build.gradle @@ -30,6 +30,7 @@ jar { exclude 'META-INF/*.SF' exclude 'META-INF/*.DSA' exclude 'META-INF/*.RSA' + exclude '**/*.kt' } } from (zipTree(project.file('../out/dokka.jar'))) { @@ -37,6 +38,7 @@ jar { exclude 'META-INF/*.SF' exclude 'META-INF/*.DSA' exclude 'META-INF/*.RSA' + exclude '**/*.kt' } } diff --git a/lib/kotlin-for-upsource.jar b/lib/kotlin-for-upsource.jar Binary files differindex 78096350..e48549d3 100644 --- a/lib/kotlin-for-upsource.jar +++ b/lib/kotlin-for-upsource.jar diff --git a/lib/markdown.jar b/lib/markdown.jar Binary files differindex 4ca022d5..9765d80a 100644 --- a/lib/markdown.jar +++ b/lib/markdown.jar diff --git a/src/Kotlin/DocumentationBuilder.kt b/src/Kotlin/DocumentationBuilder.kt index bea2f6fa..eda69841 100644 --- a/src/Kotlin/DocumentationBuilder.kt +++ b/src/Kotlin/DocumentationBuilder.kt @@ -18,6 +18,8 @@ import org.jetbrains.kotlin.name.FqName import org.jetbrains.kotlin.psi.JetParameter import org.jetbrains.kotlin.resolve.DescriptorUtils import org.jetbrains.kotlin.resolve.constants.CompileTimeConstant +import org.jetbrains.kotlin.resolve.constants.ConstantValue +import org.jetbrains.kotlin.resolve.constants.TypedCompileTimeConstant import org.jetbrains.kotlin.resolve.lazy.ResolveSession import org.jetbrains.kotlin.resolve.source.PsiSourceElement import org.jetbrains.kotlin.resolve.source.getPsi @@ -685,7 +687,7 @@ class DocumentationBuilder(val resolutionFacade: ResolutionFacade, val node = DocumentationNode(annotationClass.getName().asString(), Content.Empty, DocumentationNode.Kind.Annotation) val arguments = getAllValueArguments().toList().sortBy { it.first.getIndex() } arguments.forEach { - val valueNode = it.second.build() + val valueNode = it.second.toDocumentationNode() if (valueNode != null) { val paramNode = DocumentationNode(it.first.getName().asString(), Content.Empty, DocumentationNode.Kind.Parameter) paramNode.append(valueNode, DocumentationReference.Kind.Detail) @@ -695,15 +697,20 @@ class DocumentationBuilder(val resolutionFacade: ResolutionFacade, return node } - fun CompileTimeConstant<out Any?>.build(): DocumentationNode? { - val value = getValue() - val valueString = when(value) { + fun CompileTimeConstant<Any?>.build(): DocumentationNode? = when (this) { + is TypedCompileTimeConstant -> constantValue.toDocumentationNode() + else -> null + } + + fun ConstantValue<*>.toDocumentationNode(): DocumentationNode? = value?.let { value -> + when (value) { is String -> "\"" + StringUtil.escapeStringCharacters(value) + "\"" is EnumEntrySyntheticClassDescriptor -> - value.getContainingDeclaration().getName().asString() + "." + value.getName() - else -> value?.toString() + value.containingDeclaration.name.asString() + "." + value.name.asString() + else -> value.toString() + }.let { valueString -> + DocumentationNode(valueString, Content.Empty, DocumentationNode.Kind.Value) } - return if (valueString != null) DocumentationNode(valueString, Content.Empty, DocumentationNode.Kind.Value) else null } } diff --git a/src/Languages/JavaLanguageService.kt b/src/Languages/JavaLanguageService.kt index 7446b34f..e491d1bd 100644 --- a/src/Languages/JavaLanguageService.kt +++ b/src/Languages/JavaLanguageService.kt @@ -123,9 +123,9 @@ public class JavaLanguageService : LanguageService { val receiver = node.details(Kind.Receiver).singleOrNull() append("(") if (receiver != null) - append((listOf(receiver) + node.details(Kind.Parameter)).map { renderParameter(it) }.join()) + (listOf(receiver) + node.details(Kind.Parameter)).map { renderParameter(it) }.joinTo(this) else - append(node.details(Kind.Parameter).map { renderParameter(it) }.join()) + node.details(Kind.Parameter).map { renderParameter(it) }.joinTo(this) append(")") }.toString() diff --git a/src/Model/DocumentationNode.kt b/src/Model/DocumentationNode.kt index 7f862183..2f0638bc 100644 --- a/src/Model/DocumentationNode.kt +++ b/src/Model/DocumentationNode.kt @@ -101,6 +101,7 @@ public open class DocumentationNode(val name: String, Value, SourceUrl, + SourcePosition, /** * A note which is rendered once on a page documenting a group of overloaded functions. diff --git a/src/Model/SourceLinks.kt b/src/Model/SourceLinks.kt index fc3293f2..4530518f 100644 --- a/src/Model/SourceLinks.kt +++ b/src/Model/SourceLinks.kt @@ -4,16 +4,15 @@ import com.intellij.psi.PsiElement import java.io.File import com.intellij.psi.PsiDocumentManager import com.intellij.psi.PsiNameIdentifierOwner +import org.jetbrains.kotlin.psi.psiUtil.startOffset class SourceLinkDefinition(val path: String, val url: String, val lineSuffix: String?) fun DocumentationNode.appendSourceLink(psi: PsiElement?, sourceLinks: List<SourceLinkDefinition>) { - val path = psi?.getContainingFile()?.getVirtualFile()?.getPath() - if (path == null) { - return - } - val target = if (psi is PsiNameIdentifierOwner) psi.getNameIdentifier() else psi - val absPath = File(path).getAbsolutePath() + val path = psi?.containingFile?.virtualFile?.path ?: return + + val target = if (psi is PsiNameIdentifierOwner) psi.nameIdentifier else psi + val absPath = File(path).absolutePath val linkDef = sourceLinks.firstOrNull { absPath.startsWith(it.path) } if (linkDef != null) { var url = linkDef.url + path.substring(linkDef.path.length()) @@ -26,10 +25,33 @@ fun DocumentationNode.appendSourceLink(psi: PsiElement?, sourceLinks: List<Sourc append(DocumentationNode(url, Content.Empty, DocumentationNode.Kind.SourceUrl), DocumentationReference.Kind.Detail); } + + if (target != null) { + append(DocumentationNode(target.sourcePosition(), Content.Empty, DocumentationNode.Kind.SourcePosition), DocumentationReference.Kind.Detail) + } +} + +private fun PsiElement.sourcePosition(): String { + val path = containingFile.virtualFile.path + val lineNumber = lineNumber() + val columnNumber = columnNumber() + + return when { + lineNumber == null -> path + columnNumber == null -> "$path:$lineNumber" + else -> "$path:$lineNumber:$columnNumber" + } } fun PsiElement.lineNumber(): Int? { - val doc = PsiDocumentManager.getInstance(getProject()).getDocument(getContainingFile()) + val doc = PsiDocumentManager.getInstance(project).getDocument(containingFile) // IJ uses 0-based line-numbers; external source browsers use 1-based - return doc?.getLineNumber(getTextRange().getStartOffset())?.plus(1) + return doc?.getLineNumber(textRange.startOffset)?.plus(1) } + +fun PsiElement.columnNumber(): Int? { + val doc = PsiDocumentManager.getInstance(project).getDocument(containingFile) + // IJ uses 0-based line-numbers; external source browsers use 1-based + val lineNumber = doc?.getLineNumber(textRange.startOffset)?.plus(1) ?: return null + return startOffset - doc!!.getLineStartOffset(lineNumber) +}
\ No newline at end of file |