azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

FIR IDE: add KDoc for KtSymbol.psi

Browse Source
This commit is contained in:
Ilya Kirillov
2021-02-02 14:46:42 +01:00
parent aed728c4d8
commit f7aec31abf
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/idea-frontend-api/src/org/jetbrains/kotlin/idea/frontend/api/symbols/KtSymbol.kt
+8
View File
@@ -11,6 +11,14 @@ import org.jetbrains.kotlin.idea.frontend.api.symbols.pointers.KtSymbolPointer
interface KtSymbol : ValidityTokenOwner { interface KtSymbol : ValidityTokenOwner {
val origin: KtSymbolOrigin 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? val psi: PsiElement?
fun createPointer(): KtSymbolPointer<KtSymbol> fun createPointer(): KtSymbolPointer<KtSymbol>