From 6196e90fa66b779ae6a53acaea892cb2412854dd Mon Sep 17 00:00:00 2001
From: Alexander Slesarenko <avslesarenko@gmail.com>
Date: Thu, 4 Apr 2024 12:50:14 +0100
Subject: [PATCH] v5.0.14-RC: ScalaDoc for ReflectionData is improved

---
 .../main/scala/sigma/reflection/ReflectionData.scala   | 10 ++++++++--
 .../src/main/scala/sigma/SigmaDataReflection.scala     |  4 ++++
 .../main/scala/sigmastate/InterpreterReflection.scala  |  4 ++++
 .../src/main/scala/scalan/GraphIRReflection.scala      |  4 ++++
 4 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/core/shared/src/main/scala/sigma/reflection/ReflectionData.scala b/core/shared/src/main/scala/sigma/reflection/ReflectionData.scala
index 2aac1a5670..028e68bf72 100644
--- a/core/shared/src/main/scala/sigma/reflection/ReflectionData.scala
+++ b/core/shared/src/main/scala/sigma/reflection/ReflectionData.scala
@@ -9,9 +9,15 @@ import scala.collection.mutable
 import scala.collection.immutable
 
 /** Reflection metadata and global dictionaries to access it.
-  * For each class of this module that needs reflection metadata,
-  * we register a class entry with the necessary information.
+  * Such metadata is only used on JS platform to support reflection-like interfaces of
+  * RClass, RMethod, RConstructor. These interfaces implemented on JVM using Java
+  * reflection.
+  *
+  * For each class that needs reflection metadata, we register a class entry using
+  * `registerClassEntry` method with the necessary information such as constructors and
+  * methods.
   * Only information that is needed at runtime is registered.
+  * @see mkConstructor, mkMethod
   */
 object ReflectionData {
   /** Descriptors of classes. */
diff --git a/data/shared/src/main/scala/sigma/SigmaDataReflection.scala b/data/shared/src/main/scala/sigma/SigmaDataReflection.scala
index 31703b0856..48939b1460 100644
--- a/data/shared/src/main/scala/sigma/SigmaDataReflection.scala
+++ b/data/shared/src/main/scala/sigma/SigmaDataReflection.scala
@@ -11,6 +11,10 @@ import sigma.reflection.{ReflectionData, mkConstructor, mkMethod}
 import sigma.serialization.ValueCodes.OpCode
 
 /** Reflection metadata for `interpreter` module.
+  * Such metadata is only used on JS platform to support reflection-like interfaces of
+  * RClass, RMethod, RConstructor. These interfaces implemented on JVM using Java
+  * reflection.
+  *
   * For each class of this module that needs reflection metadata,
   * we register a class entry with the necessary information.
   * Only information that is needed at runtime is registered.
diff --git a/interpreter/shared/src/main/scala/sigmastate/InterpreterReflection.scala b/interpreter/shared/src/main/scala/sigmastate/InterpreterReflection.scala
index 8b18e20459..9a06322166 100644
--- a/interpreter/shared/src/main/scala/sigmastate/InterpreterReflection.scala
+++ b/interpreter/shared/src/main/scala/sigmastate/InterpreterReflection.scala
@@ -8,6 +8,10 @@ import sigmastate.crypto.GF2_192_Poly
 import sigmastate.crypto.VerifierMessage.Challenge
 
 /** Reflection metadata for `interpreter` module.
+  * Such metadata is only used on JS platform to support reflection-like interfaces of
+  * RClass, RMethod, RConstructor. These interfaces implemented on JVM using Java
+  * reflection.
+  *
   * For each class of this module that needs reflection metadata,
   * we register a class entry with the necessary information.
   * Only information that is needed at runtime is registered.
diff --git a/sc/shared/src/main/scala/scalan/GraphIRReflection.scala b/sc/shared/src/main/scala/scalan/GraphIRReflection.scala
index ee29924fb7..0eaba9d8a3 100644
--- a/sc/shared/src/main/scala/scalan/GraphIRReflection.scala
+++ b/sc/shared/src/main/scala/scalan/GraphIRReflection.scala
@@ -11,6 +11,10 @@ import special.wrappers.{OptionWrapSpec, RTypeWrapSpec}
 import wrappers.scalan.WRTypes
 
 /** Registrations of reflection metadata for graph-ir module (see README.md).
+  * Such metadata is only used on JS platform to support reflection-like interfaces of
+  * RClass, RMethod, RConstructor. These interfaces implemented on JVM using Java
+  * reflection.
+  *
   * For each class of this module that needs reflection metadata,
   * we register a class entry with the necessary information.
   * Only information that is needed at runtime is registered.