[AA] Update content scope-related KDoc

^KT-73290

Author: marcopennekamp

analysis/analysis-api-platform-interface/src/org/jetbrains/kotlin/analysis/api/platform/projectStructure/KaContentScopeProvider.kt

@@ -11,6 +11,9 @@ import com.intellij.psi.search.GlobalSearchScope
 import org.jetbrains.kotlin.analysis.api.platform.KaEngineService
 import org.jetbrains.kotlin.analysis.api.projectStructure.KaModule
 
+/**
+ * An engine services which *must* be used to calculate a [KaModule]'s [content scope][KaModule.contentScope] lazily.
+ */
 public interface KaContentScopeProvider : KaEngineService {
     /**
      * Calculates a [KaModule.contentScope] from [KaModule.baseContentScope] for the given [KaModule] using [KotlinContentScopeRefiner]s.
@@ -20,4 +23,4 @@ public interface KaContentScopeProvider : KaEngineService {
     public companion object {
         public fun getInstance(project: Project): KaContentScopeProvider = project.service()
     }
-}
+}

analysis/analysis-api/api/analysis-api-platform-interface.undocumented

@@ -75,7 +75,6 @@ permissions/KaAnalysisPermissionChecker.kt:KaAnalysisPermissionChecker:isAnalysi
 permissions/KotlinAnalysisPermissionOptions.kt:Companion:getInstance()
 permissions/KotlinDefaultAnalysisPermissionOptions.kt:KotlinDefaultAnalysisPermissionOptions
 projectStructure/KaContentScopeProvider.kt:Companion:getInstance(Project)
-projectStructure/KaContentScopeProvider.kt:KaContentScopeProvider
 projectStructure/KaDanglingFileModuleImpl.kt:KaDanglingFileModuleImpl
 projectStructure/KaDanglingFileModuleImpl.kt:KaDanglingFileModuleImpl:null
 projectStructure/KaModuleBase.kt:abstract KaModuleBase

analysis/analysis-api/src/org/jetbrains/kotlin/analysis/api/projectStructure/KaModule.kt

@@ -76,19 +76,20 @@ public interface KaModule {
     public val directFriendDependencies: List<KaModule>
 
     /**
-     * A base content scope of the module,
-     * which is not yet refined by extension and restriction scopes provided by [KotlinContentScopeRefiner].
+     * A base content scope of the module, which is not yet refined by extension and restriction scopes provided by
+     * `KotlinContentScopeRefiner`.
      *
-     * Note that [baseContentScope] doesn't represent the actual content scope of the current module.
-     * To get a content scope of the module, [contentScope] should be used instead.
+     * Note that [baseContentScope] doesn't represent the actual content scope of the current module. To get a content scope of the module,
+     * [contentScope] should be used instead.
      */
     @KaPlatformInterface
     public val baseContentScope: GlobalSearchScope
 
     /**
-     * Represents the content scope of a current module, i.e.,
-     * a [GlobalSearchScope] which determines all the files that are contained in the module.
-     * This scope is lazily built from [baseContentScope] using [KotlinContentScopeRefiner] extension points.
+     * Represents the content scope of a current module, i.e., a [GlobalSearchScope] which determines all the files that are contained in
+     * the module.
+     *
+     * This scope should be lazily built from [baseContentScope] using `KotlinContentScopeRefiner` extension points.
      */
     public val contentScope: GlobalSearchScope