From 0b7ef0349088281848029dab6ac310c4ab20f48c Mon Sep 17 00:00:00 2001
From: Dmitrii Gridin <dmitry.gridin@jetbrains.com>
Date: Thu, 2 Feb 2023 15:01:06 +0100
Subject: [PATCH] [SLC] AnnotationFilter: add kdoc

^KT-56046
---
 .../classes/symbol/annotations/AnnotationFilter.kt   | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationFilter.kt b/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationFilter.kt
index 844edada355..f1fa79ef1ed 100644
--- a/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationFilter.kt
+++ b/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationFilter.kt
@@ -7,7 +7,19 @@ package org.jetbrains.kotlin.light.classes.symbol.annotations
 
 import com.intellij.psi.PsiAnnotation
 
+/**
+ * Provider a filter for resulted annotations from [LazyAnnotationsBox]
+ *
+ * @see LazyAnnotationsBox
+ */
 internal sealed interface AnnotationFilter {
+    /**
+     * @return **true** if an annotations with [qualifiedName] is allowed
+     */
     fun isAllowed(qualifiedName: String): Boolean
+
+    /**
+     * @return a filtered collection where each annotation in a list has an allowed qualifier
+     */
     fun filtered(annotations: Collection<PsiAnnotation>): Collection<PsiAnnotation>
 }