From 37b0c20879cc6d80870341714eddd55e6204b49a Mon Sep 17 00:00:00 2001 From: Ilya Kirillov Date: Wed, 15 Jun 2022 17:27:40 +0200 Subject: [PATCH] [Analysis API] improve KDoc for scopes --- .../src/org/jetbrains/kotlin/analysis/api/scopes/KtScope.kt | 3 ++- .../org/jetbrains/kotlin/analysis/api/scopes/KtScopeLike.kt | 6 +++--- .../org/jetbrains/kotlin/analysis/api/scopes/KtTypeScope.kt | 3 ++- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScope.kt b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScope.kt index cf70266a720..51cbc070e76 100644 --- a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScope.kt +++ b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScope.kt @@ -29,7 +29,8 @@ public interface KtScope : KtScopeLike { public fun getCallableSymbols(nameFilter: KtScopeNameFilter = { true }): Sequence /** - * Return a sequence of [KtClassifierSymbol] which current scope contain if declaration name matches [nameFilter] + * Return a sequence of [KtClassifierSymbol] which current scope contain if classifier name matches [nameFilter]. The sequence includes: + * nested classes, inner classes, nested type aliases for the class scope, and top-level classes and top-level type aliases for file scope. */ public fun getClassifierSymbols(nameFilter: KtScopeNameFilter = { true }): Sequence diff --git a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScopeLike.kt b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScopeLike.kt index 3bce38e8f49..9c9ac3e628d 100644 --- a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScopeLike.kt +++ b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtScopeLike.kt @@ -11,7 +11,7 @@ import org.jetbrains.kotlin.name.Name public interface KtScopeLike : KtLifetimeOwner { /** - * Returns a **subset** of names which current scope may contain. + * Returns a **superset** of names which current scope may contain. * In other words `ALL_NAMES(scope)` is a subset of `scope.getAllNames()` */ public fun getAllPossibleNames(): Set = withValidityAssertion { @@ -19,13 +19,13 @@ public interface KtScopeLike : KtLifetimeOwner { } /** - * Returns a **subset** of callable names which current scope may contain. + * Returns a **superset** of callable names which current scope may contain. * In other words `ALL_CALLABLE_NAMES(scope)` is a subset of `scope.getCallableNames()` */ public fun getPossibleCallableNames(): Set /** - * Returns a **subset** of classifier names which current scope may contain. + * Returns a **superset** of classifier names which current scope may contain. * In other words `ALL_CLASSIFIER_NAMES(scope)` is a subset of `scope.getClassifierNames()` */ public fun getPossibleClassifierNames(): Set diff --git a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtTypeScope.kt b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtTypeScope.kt index c200e7b9f35..d35044844d4 100644 --- a/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtTypeScope.kt +++ b/analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/scopes/KtTypeScope.kt @@ -23,7 +23,8 @@ public interface KtTypeScope : KtScopeLike { public fun getCallableSignatures(nameFilter: KtScopeNameFilter = { true }): Sequence> /** - * Return a sequence of [KtClassifierSymbol] which current scope contain if declaration name matches [nameFilter] + * Return a sequence of [KtClassifierSymbol] which current scope contain if classifier name matches [nameFilter]. The sequence includes: + * nested classes, inner classes, nested type aliases for the class scope, and top-level classes and top-level type aliases for file scope. */ public fun getClassifierSymbols(nameFilter: KtScopeNameFilter = { true }): Sequence