From 85f7d4d928c2259f7a8d7810cc1cc9be79aae6cc Mon Sep 17 00:00:00 2001
From: Nicolay Mitropolsky <nicolay.mitropolsky@jetbrains.com>
Date: Fri, 28 Apr 2023 11:09:27 +0200
Subject: [PATCH] IJ-CR-106433: docs and one more assert

GitOrigin-RevId: cad56cc9600e62c9e93d48184df0b774d8faf84e
---
 .../core-api/src/com/intellij/psi/PsiReferencesWrapper.java  | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/platform/core-api/src/com/intellij/psi/PsiReferencesWrapper.java b/platform/core-api/src/com/intellij/psi/PsiReferencesWrapper.java
index a7c12ca7a126..03d0d6c1f3ad 100644
--- a/platform/core-api/src/com/intellij/psi/PsiReferencesWrapper.java
+++ b/platform/core-api/src/com/intellij/psi/PsiReferencesWrapper.java
@@ -7,6 +7,11 @@ import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.List;
 
+/**
+ * An interface for {@link PsiReference}-es that wraps another (multiple) references.
+ * Is useful for cases when references need a complicated priority or range computations and/or lazy reference computation.
+ * But in general wrapping references should not be considered as a good practice and should be used only in interaction with legacy code.
+ */
 @ApiStatus.Experimental
 public interface PsiReferencesWrapper {