From 015b2a33571057be96903702945f38ce4230ff1c Mon Sep 17 00:00:00 2001
From: Dmitrii Gridin <dmitry.gridin@jetbrains.com>
Date: Thu, 2 Feb 2023 12:37:56 +0100
Subject: [PATCH] [SLC] AnnotationsBox: add kdoc

^KT-56046
---
 .../light/classes/symbol/annotations/AnnotationsBox.kt   | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationsBox.kt b/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationsBox.kt
index 87491234973..443fd3a9491 100644
--- a/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationsBox.kt
+++ b/analysis/symbol-light-classes/src/org/jetbrains/kotlin/light/classes/symbol/annotations/AnnotationsBox.kt
@@ -8,6 +8,15 @@ package org.jetbrains.kotlin.light.classes.symbol.annotations
 import com.intellij.psi.PsiAnnotation
 import com.intellij.psi.PsiModifierList
 
+/**
+ * This class is used as a proxy for [com.intellij.psi.PsiAnnotationOwner].
+ *
+ * [LazyAnnotationsBox] provides an ability to compute each annotation separately and in a lazy way to avoid heavy computation.
+ * [SimpleAnnotationsBox] provides an ability to compute all annotations once on first access.
+ * [EmptyAnnotationsBox] just a box without annotations.
+ *
+ * @see org.jetbrains.kotlin.light.classes.symbol.modifierLists.SymbolLightModifierList
+ */
 internal sealed interface AnnotationsBox {
     fun annotationsArray(owner: PsiModifierList): Array<PsiAnnotation>
     fun findAnnotation(owner: PsiModifierList, qualifiedName: String): PsiAnnotation?