From 9e8547da68c19dcb9f985be336a97a52ca7ea1f6 Mon Sep 17 00:00:00 2001
From: Roman Ivanov <roman.ivanov@jetbrains.com>
Date: Mon, 13 Jun 2022 17:22:45 +0200
Subject: [PATCH] update javadoc

GitOrigin-RevId: 0a2e807e54a0eddbcd2e55e05a9ee8709ad46226
---
 .../src/com/intellij/psi/PsiRecordPattern.java        | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/java/java-psi-api/src/com/intellij/psi/PsiRecordPattern.java b/java/java-psi-api/src/com/intellij/psi/PsiRecordPattern.java
index ef842aa82847..2a4c23aa0015 100644
--- a/java/java-psi-api/src/com/intellij/psi/PsiRecordPattern.java
+++ b/java/java-psi-api/src/com/intellij/psi/PsiRecordPattern.java
@@ -6,14 +6,25 @@ import org.jetbrains.annotations.Nullable;
 
 /**
  * <a href="https://openjdk.java.net/jeps/405">JEP</a>
+ * <p>
+ * Represents record pattern, for example: {@code Point(int x, int y) p }
  */
 public interface PsiRecordPattern extends PsiPrimaryPattern {
+  /**
+   * @return element representing code inside '(...)' inclusive parenthesis
+   */
   @NotNull
   PsiRecordStructurePattern getStructurePattern();
 
+  /**
+   * @return type of the pattern, for example in {@code Point(int x, int y) p } it is {@code Point }
+   */
   @NotNull
   PsiTypeElement getTypeElement();
 
+  /**
+   * @return pattern variable if the pattern has a name, {@code null} otherwise
+   */
   @Nullable
   PsiRecordPatternVariable getPatternVariable();
 }