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

FIR IDE: add kdoc for KtAnalysisSession

Browse Source
This commit is contained in:
Ilya Kirillov
2020-07-10 15:00:53 +03:00
parent b8caefa0c4
commit 1c195ea2bb
1 changed files with 11 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/KtAnalysisSession.kt
+11
View File
@@ -12,6 +12,17 @@ import org.jetbrains.kotlin.idea.frontend.api.types.KtType
import org.jetbrains.kotlin.name.ClassId import org.jetbrains.kotlin.name.ClassId
import org.jetbrains.kotlin.psi.* import org.jetbrains.kotlin.psi.*
/**
* The entry point into all frontend-related work. Has the following contracts:
* - Should not be accessed from event dispatch thread
* - Should not be accessed outside read action
* - Should not be leaked outside read action it was created in
* - All entities retrieved from analysis facade should not be leaked outside the read action KtAnalysisSession was created in
*
* To pass a symbol from one read action to another use [KtSymbolPointer] which can be created from a symbol by [KtSymbol.createPointer]
*
* To create analysis session consider using [analyze]
*/
abstract class KtAnalysisSession(override val token: ValidityToken) : ValidityTokenOwner { abstract class KtAnalysisSession(override val token: ValidityToken) : ValidityTokenOwner {
abstract val symbolProvider: KtSymbolProvider abstract val symbolProvider: KtSymbolProvider
abstract val scopeProvider: KtScopeProvider abstract val scopeProvider: KtScopeProvider