I'm writing scaladoc!

Quafadas · Jan 3, 2024 · 1500326 · 1500326
1 parent 5a99cb8
commit 1500326
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/scautable/jvm/src/jvmSpecific.scala b/scautable/jvm/src/jvmSpecific.scala
@@ -31,6 +31,13 @@ trait PlatformSpecific {
       runtime.exec(Array[String](s"""xdg-open $uri]"""))
   }
 
+  /**
+    * Attempts to open a browser window, and display this Seq of `Product` as a table.
+    *
+    * @param a - seq of case classes
+    * @param tableDeriveInstance - summon a HtmlTableRender instance for the case class
+    * @return
+    */
   def desktopShow[A <: Product](a: Seq[A])(using tableDeriveInstance: HtmlTableRender[A]) = {
     val asString = scautable(a).toString()
     val theHtml = raw"""

diff --git a/scautable/src/package.scala b/scautable/src/package.scala
@@ -8,7 +8,7 @@ import java.time.LocalDate
 import scalatags.Text.TypedTag
 
 /**
-  * This is a simple library to render a scala case class as an html table. It assumes the presence of a HtmlTableRender instance for each type in the case class.
+  * This is a simple library to render a scala case class as an html table. It assumes the presence of a [[HtmlTableRender]] instance for each type in the case class.
   */
 object scautable extends PlatformSpecific {