Added comment

takapi327 · Dec 31, 2024 · 68d356a · 68d356a
1 parent dfb4eba
commit 68d356a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/module/ldbc-dsl/src/main/scala/ldbc/dsl/codec/Codec.scala b/module/ldbc-dsl/src/main/scala/ldbc/dsl/codec/Codec.scala
@@ -16,6 +16,12 @@ import org.typelevel.twiddles.TwiddleSyntax
 
 import ldbc.sql.ResultSet
 
+/**
+ * Symmetric encoder and decoder of MySQL data to and from Scala types.
+ *
+ * @tparam A
+ *   Types handled in Scala
+ */
 trait Codec[A] extends Encoder[A], Decoder[A]:
   self =>
 

diff --git a/module/ldbc-dsl/src/main/scala/ldbc/dsl/codec/Decoder.scala b/module/ldbc-dsl/src/main/scala/ldbc/dsl/codec/Decoder.scala
@@ -17,7 +17,7 @@ import org.typelevel.twiddles.TwiddleSyntax
 import ldbc.sql.ResultSet
 
 /**
- * Class to get the DataType that matches the Scala type information from the ResultSet.
+ * Trait to get the DataType that matches the Scala type information from the ResultSet.
  *
  * @tparam A
  *   Scala types that match SQL DataType