diff options
author | Dmitry Jemerov <yole@jetbrains.com> | 2015-10-29 13:31:16 +0100 |
---|---|---|
committer | Dmitry Jemerov <yole@jetbrains.com> | 2015-10-29 13:31:16 +0100 |
commit | 4e09ac20457e2c4398406a1c23bf1f435f31349e (patch) | |
tree | 87e074f00e3d31ac3c73a2b1d64ad7fc20375f8d /src | |
parent | c9d59e9ae85f76e021d53c77ef18bfce0ff7ec7c (diff) | |
parent | 8216501e9a07940ed0a0be3d204733df9a9d811c (diff) | |
download | dokka-4e09ac20457e2c4398406a1c23bf1f435f31349e.tar.gz dokka-4e09ac20457e2c4398406a1c23bf1f435f31349e.tar.bz2 dokka-4e09ac20457e2c4398406a1c23bf1f435f31349e.zip |
Merge branch 'javadoc' of https://github.com/cy6erGn0m/dokka into cy6erGn0m-javadoc
# Conflicts:
# dokka.iml
# javadoc/javadoc.iml
# javadoc/src/main/kotlin/docbase.kt
# javadoc/src/main/kotlin/dokka-adapters.kt
# javadoc/src/main/kotlin/reporter.kt
# javadoc/src/main/kotlin/tags.kt
# src/Analysis/AnalysisEnvironment.kt
# src/Analysis/CompilerAPI.kt
# src/Formats/KotlinWebsiteFormatService.kt
# src/Formats/StructuredFormatService.kt
# src/Java/JavaDocumentationBuilder.kt
# src/Kotlin/ContentBuilder.kt
# src/Kotlin/DocumentationBuilder.kt
# src/Languages/JavaLanguageService.kt
# src/Model/Content.kt
# src/Model/PackageDocs.kt
# src/Utilities/GuiceModule.kt
# src/Utilities/Path.kt
# src/Utilities/ServiceLocator.kt
# test/src/markdown/MarkdownTestRunner.kt
Diffstat (limited to 'src')
-rw-r--r-- | src/Java/JavaDocumentationBuilder.kt | 10 | ||||
-rw-r--r-- | src/Languages/JavaLanguageService.kt | 12 | ||||
-rw-r--r-- | src/Model/Content.kt | 7 | ||||
-rw-r--r-- | src/Model/DocumentationNode.kt | 5 | ||||
-rw-r--r-- | src/Utilities/Path.kt | 5 |
5 files changed, 28 insertions, 11 deletions
diff --git a/src/Java/JavaDocumentationBuilder.kt b/src/Java/JavaDocumentationBuilder.kt index 01ecb478..88c13d38 100644 --- a/src/Java/JavaDocumentationBuilder.kt +++ b/src/Java/JavaDocumentationBuilder.kt @@ -108,8 +108,11 @@ public class JavaDocumentationBuilder(private val options: DocumentationOptions, } private fun MutableContent.convertSeeTag(tag: PsiDocTag) { - val linkElement = tag.linkElement() ?: return - val seeSection = findSectionByTag("See Also") ?: addSection("See Also", null) + val linkElement = tag.linkElement() + if (linkElement == null) { + return + } + val seeSection = findSectionByTag(ContentTags.SeeAlso) ?: addSection(ContentTags.SeeAlso, null) val linkSignature = resolveLink(linkElement) val text = ContentText(linkElement.text) if (linkSignature != null) { @@ -189,7 +192,7 @@ public class JavaDocumentationBuilder(private val options: DocumentationOptions, is PsiField -> element.containingClass!!.qualifiedName + "#" + element.name is PsiMethod -> element.containingClass!!.qualifiedName + "#" + element.name + "(" + - element.parameterList.parameters.map { it.type.typeSignature() }.joinToString(",") + ")" + element.parameterList.parameters.map { it.type.typeSignature() }.join(",") + ")" else -> null } @@ -339,6 +342,7 @@ public class JavaDocumentationBuilder(private val options: DocumentationOptions, fun DocumentationNode.appendModifiers(element: PsiModifierListOwner) { val modifierList = element.modifierList ?: return + PsiModifier.MODIFIERS.forEach { if (it != "static" && modifierList.hasExplicitModifier(it)) { appendTextNode(it, Kind.Modifier) diff --git a/src/Languages/JavaLanguageService.kt b/src/Languages/JavaLanguageService.kt index 8648448e..5750588e 100644 --- a/src/Languages/JavaLanguageService.kt +++ b/src/Languages/JavaLanguageService.kt @@ -48,6 +48,18 @@ public class JavaLanguageService : LanguageService { } } + public fun getArrayElementType(node: DocumentationNode): DocumentationNode? = when (node.name) { + "Array" -> node.details(Kind.Type).singleOrNull()?.let { et -> getArrayElementType(et) ?: et } ?: DocumentationNode("Object", node.content, DocumentationNode.Kind.ExternalClass) + "IntArray", "LongArray", "ShortArray", "ByteArray", "CharArray", "DoubleArray", "FloatArray", "BooleanArray" -> DocumentationNode(node.name.removeSuffix("Array").toLowerCase(), node.content, DocumentationNode.Kind.Type) + else -> null + } + + public fun getArrayDimension(node: DocumentationNode): Int = when (node.name) { + "Array" -> 1 + (node.details(DocumentationNode.Kind.Type).singleOrNull()?.let { getArrayDimension(it) } ?: 0) + "IntArray", "LongArray", "ShortArray", "ByteArray", "CharArray", "DoubleArray", "FloatArray", "BooleanArray" -> 1 + else -> 0 + } + public fun renderType(node: DocumentationNode): String { return when (node.name) { "Unit" -> "void" diff --git a/src/Model/Content.kt b/src/Model/Content.kt index e7dfc241..45d42a2d 100644 --- a/src/Model/Content.kt +++ b/src/Model/Content.kt @@ -126,6 +126,11 @@ public class ContentSection(public val tag: String, public val subjectName: Stri children.hashCode() * 31 * 31 + tag.hashCode() * 31 + (subjectName?.hashCode() ?: 0) } +public object ContentTags { + val Description = "Description" + val SeeAlso = "See Also" +} + fun content(body: ContentBlock.() -> Unit): ContentBlock { val block = ContentBlock() block.body() @@ -189,7 +194,7 @@ public open class MutableContent() : Content() { if (descriptionNodes.isEmpty()) { ContentEmpty } else { - val result = ContentSection("Description", null) + val result = ContentSection(ContentTags.Description, null) result.children.addAll(descriptionNodes) result } diff --git a/src/Model/DocumentationNode.kt b/src/Model/DocumentationNode.kt index 468cb878..4a77f761 100644 --- a/src/Model/DocumentationNode.kt +++ b/src/Model/DocumentationNode.kt @@ -123,9 +123,7 @@ public class DocumentationModule(name: String, content: Content = Content.Empty) val DocumentationNode.path: List<DocumentationNode> get() { - val parent = owner - if (parent == null) - return listOf(this) + val parent = owner ?: return listOf(this) return parent.path + this } @@ -143,6 +141,7 @@ fun DocumentationNode.findOrCreatePackageNode(packageName: String, packageConten fun DocumentationNode.append(child: DocumentationNode, kind: DocumentationReference.Kind) { addReferenceTo(child, kind) + @suppress("NON_EXHAUSTIVE_WHEN") when (kind) { DocumentationReference.Kind.Detail -> child.addReferenceTo(this, DocumentationReference.Kind.Owner) DocumentationReference.Kind.Member -> child.addReferenceTo(this, DocumentationReference.Kind.Owner) diff --git a/src/Utilities/Path.kt b/src/Utilities/Path.kt index 292b0eed..36277d9f 100644 --- a/src/Utilities/Path.kt +++ b/src/Utilities/Path.kt @@ -4,10 +4,7 @@ import java.io.File import java.io.IOException fun File.getRelativePath(name: File): File { - val parent = parentFile - - if (parent == null) - throw IOException("No common directory"); + val parent = parentFile ?: throw IOException("No common directory") val basePath = canonicalPath + File.separator; val targetPath = name.canonicalPath; |