src/Analysis/CommentsAPI.kt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

package org.jetbrains.dokka

import org.jetbrains.jet.lang.descriptors.*
import org.jetbrains.jet.lang.resolve.*
import org.jetbrains.jet.kdoc.psi.api.*
import org.jetbrains.jet.lang.psi.*

fun BindingContext.getDocumentationElements(descriptor: DeclarationDescriptor): List<KDoc> {
    val psiElement = DescriptorToSourceUtils.descriptorToDeclaration(descriptor)
    if (psiElement == null)
        return listOf()

    return psiElement.previousSiblings() // go backwards
            .takeWhile { it !is JetDeclaration } // till previous declaration
            .filter { it is KDoc } // get KDocs
            .map { it as KDoc } // cast
            .toList()
            .reverse() // make reversed list
}

fun KDoc?.extractText(): String {
    if (this == null)
        return ""
    val text = getText()
    if (text == null)
        return ""
    val lines = text.replace("\r", "").split("\n")
    return lines.map {
        val comment = it.trim().dropWhile { it == '/' || it == '*' }
        (if (comment.endsWith("*/"))
            comment.substring(0, comment.length - 2)
        else
            comment).trim()
    }.filter { it.any() }.join("\n")
}