[Analysis API] improve KDoc for scopes

This commit is contained in:
Ilya Kirillov
2022-06-15 17:27:40 +02:00
parent d8b88e9b69
commit 37b0c20879
3 changed files with 7 additions and 5 deletions
@@ -29,7 +29,8 @@ public interface KtScope : KtScopeLike {
public fun getCallableSymbols(nameFilter: KtScopeNameFilter = { true }): Sequence<KtCallableSymbol>
/**
* 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<KtClassifierSymbol>
@@ -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<Name> = 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<Name>
/**
* 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<Name>
@@ -23,7 +23,8 @@ public interface KtTypeScope : KtScopeLike {
public fun getCallableSignatures(nameFilter: KtScopeNameFilter = { true }): Sequence<KtCallableSignature<*>>
/**
* 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<KtClassifierSymbol>