FIR IDE: add KDoc for KtSymbol.psi

2021-02-02 14:46:42 +01:00
parent aed728c4d8
commit f7aec31abf
1 changed files with 8 additions and 0 deletions
@@ -11,6 +11,14 @@ import org.jetbrains.kotlin.idea.frontend.api.symbols.pointers.KtSymbolPointer

 interface KtSymbol : ValidityTokenOwner {
    val origin: KtSymbolOrigin
+
+    /**
+     * [PsiElement] which corresponds to given [KtSymbol]
+     * If [origin] is one of [KtSymbolOrigin.SOURCE], [KtSymbolOrigin.JAVA], [KtSymbolOrigin.LIBRARY] then the source is not null
+     * For other [KtSymbolOrigin] behaviour is undefined
+     *
+     * For [KtSymbolOrigin.LIBRARY] the generated by Kotlin class file source element is returned
+     */
    val psi: PsiElement?

    fun createPointer(): KtSymbolPointer<KtSymbol>