Added documentation

tharwaninitin · Dec 21, 2023 · 27d465f · 27d465f
1 parent c324dd7
commit 27d465f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/modules/bq/src/main/scala/gcp4zio/bq/BQ.scala b/modules/bq/src/main/scala/gcp4zio/bq/BQ.scala
@@ -81,6 +81,14 @@ trait BQ {
       targetCompressionType: String = "gzip"
   ): Task[Unit]
 
+  /** Execute function with BigQuery as Input and return Generic o/p T
+    *
+    * @param f
+    *   BigQuery => T
+    * @tparam T
+    *   Output
+    * @return
+    */
   def execute[T](f: BigQuery => T): Task[T]
 }
 
@@ -230,6 +238,14 @@ object BQ {
     )
   )
 
+  /** Execute function with BigQuery as Input and return Generic o/p T
+    *
+    * @param f
+    *   BigQuery => T
+    * @tparam T
+    *   Output
+    * @return
+    */
   def execute[T](f: BigQuery => T): RIO[BQ, T] = ZIO.environmentWithZIO(_.get.execute(f))
 
   def live(credentials: scala.Option[String] = None): TaskLayer[BQ] = ZLayer.fromZIO(BQClient(credentials).map(bq => BQImpl(bq)))

diff --git a/modules/bq/src/main/scala/gcp4zio/bq/BQImpl.scala b/modules/bq/src/main/scala/gcp4zio/bq/BQImpl.scala
@@ -255,5 +255,13 @@ case class BQImpl(client: BigQuery) extends BQ {
     }
   }
 
+  /** Execute function with BigQuery as Input and return Generic o/p T
+    *
+    * @param f
+    *   BigQuery => T
+    * @tparam T
+    *   Output
+    * @return
+    */
   override def execute[T](f: BigQuery => T): Task[T] = ZIO.attempt(f(client))
 }