From f7aec31abf2674611ad61581b3e68c0b2734b768 Mon Sep 17 00:00:00 2001
From: Ilya Kirillov <ilya.kirillov@jetbrains.com>
Date: Tue, 2 Feb 2021 14:46:42 +0100
Subject: [PATCH] FIR IDE: add KDoc for KtSymbol.psi

---
 .../kotlin/idea/frontend/api/symbols/KtSymbol.kt          | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/symbols/KtSymbol.kt b/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/symbols/KtSymbol.kt
index 5c6dd0c2310..17470b68f33 100644
--- a/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/symbols/KtSymbol.kt
+++ b/idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/symbols/KtSymbol.kt
@@ -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>