Better doc comments for Scroll Restoration

zetashift · armanbilge · web-flow · commit a64b7c28880a · 2022-08-20T13:10:53.000+02:00
Co-authored-by: Arman Bilge &lt;armanbilge@gmail.com&gt;
diff --git a/dom/src/main/scala-3/org/scalajs/dom/ScrollRestoration.scala b/dom/src/main/scala-3/org/scalajs/dom/ScrollRestoration.scala
@@ -9,6 +9,8 @@ opaque type ScrollRestoration <: String = String
   * which contains the spec for ScrollRestoration
   */
 object ScrollRestoration {
+  /** The location on the page to which the user has scrolled will be restored. */
   val auto: ScrollRestoration = "auto"
+  /** The location on the page is not restored. The user will have to scroll to the location manually. */
   val manual: ScrollRestoration = "manual" 
 }

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ opaque type ScrollRestoration <: String = String`
`9`	`9`	`* which contains the spec for ScrollRestoration`
`10`	`10`	`*/`
`11`	`11`	`object ScrollRestoration {`
	`12`	`+ /** The location on the page to which the user has scrolled will be restored. */`
`12`	`13`	`val auto: ScrollRestoration = "auto"`
	`14`	`+ /** The location on the page is not restored. The user will have to scroll to the location manually. */`
`13`	`15`	`val manual: ScrollRestoration = "manual"`
`14`	`16`	`}`