Merge branch 'scaladoc/review-fixes' of https://github.com/pikinier20/dotty into scaladoc/review-fixes

Author: fanixus96

docs/_layouts/static-site-main.html

@@ -43,5 +43,12 @@
   <div class="content-contributors hidden">
     <h1 class="h200">Contributors to this page</h1>
     <div id="documentation-contributors" class="contributors-container"></div>
+    {% if urls.editSource %}
+    <div class="github-edit-button">
+      <a class="text-button with-link body-small" href="{{ urls.editSource }}">
+        Edit this page on GitHub
+      </a>
+    </div>
+    {% endif %}
   </div>
 </div>

scaladoc-js/contributors/css/content-contributors.css

@@ -1,24 +1,51 @@
 .content-contributors.hidden {
   display: none;
 }
+
+.content-contributors .contributors-container div a {
+  vertical-align: middle;
+  padding: 3px;
+  text-decoration: none;
+}
+
+.content-contributors {
+  background-color: var(--background-neutral);
+  padding: calc(3 * var(--base-spacing));
+  border-radius: 4px;
+}
+
 .content-contributors .contributors-container {
   display: flex;
   flex-wrap: wrap;
   align-items: center;
   padding-bottom: 25px;
+  row-gap: calc(3 * var(--base-spacing));
+  column-gap: calc(4 * var(--base-spacing));
 }
-.content-contributors .contributors-container div {
-  margin: 5px;
-}
-.content-contributors .contributors-container div a {
-  vertical-align: middle;
-  padding: 3px;
-  text-decoration: none;
+
+.content-contributors h1 {
+  color: var(--text-primary);
+  padding-bottom: calc(3 * var(--base-spacing));
 }
+
 .content-contributors .contributors-container div img {
   vertical-align: middle;
   width: 35px;
   height: 35px;
   margin-bottom: 0;
-  border-radius: 7px;
+  border-radius: 50%;
+  margin-right: calc(1.5 * var(--base-spacing));
+}
+
+#content .content-contributors .contributors-container div a {
+  text-decoration: none;
+  border-bottom: none;
+}
+
+.content-contributors .contributors-container {
+  padding: 0;
+}
+
+.content-contributors .github-edit-button {
+  padding-top: calc(2 * var(--base-spacing));
 }

scaladoc-testcases/docs/_layouts/static-site-main.html

@@ -34,5 +34,12 @@
   <div class="content-contributors hidden">
     <h1 class="h200">Contributors to this page</h1>
     <div id="documentation-contributors" class="contributors-container"></div>
+    {% if urls.editSource %}
+    <div class="github-edit-button">
+      <a class="text-button with-link body-small" href="{{ urls.editSource }}">
+        Edit this page on GitHub
+      </a>
+    </div>
+    {% endif %}
   </div>
 </div>

scaladoc/resources/dotty_res/scripts/components/DocumentableList.js

@@ -4,7 +4,7 @@
  *  @typedef { [key: string, value: string][] } Dataset
  */
 
-class DocumentableList extends Component {
+ class DocumentableList extends Component {
   constructor(props) {
     super(props);
 
@@ -140,7 +140,7 @@ class List {
 
     function includesInputValue() {
       const lcValue = filter.value.toLowerCase()
-      return elementData.name.toLowerCase().includes(lcValue) 
+      return elementData.name.toLowerCase().includes(lcValue)
           || elementData.description.toLowerCase().includes(lcValue);
     }
 
@@ -177,7 +177,9 @@ class List {
         .every(([filterKey, value]) => {
           const filterGroup = filter.filters[filterKey]
 
-          return value.split(",").some(v => filterGroup && filterGroup[v].selected)
+          console.log(Object.entries(filterGroup).filter(arr => arr[1].selected))
+
+          return Object.entries(filterGroup).filter(arr => arr[1].selected).length == 0 || value.split(",").some(v => (filterGroup && filterGroup[v].selected))
         })
 
       return isVisible

scaladoc/resources/dotty_res/scripts/components/Filter.js

@@ -4,7 +4,7 @@
  * @typedef { Record<FilterAttributes, FilterMap> } Filters
  */
 
-class Filter {
+ class Filter {
   /**
    * @param value { string }
    * @param filters { Filters }
@@ -217,8 +217,8 @@ class Filter {
 }
 
 class FilterItem {
-  constructor(selected = true, visible = true) {
+  constructor(selected = false, visible = true) {
     this.selected = selected
     this.visible = visible
   }
-}
+}

scaladoc/resources/dotty_res/scripts/ux.js

@@ -30,7 +30,7 @@ window.addEventListener("DOMContentLoaded", () => {
     }
   }
 
-  var memberLists = document.getElementsByClassName("membersList")
+  var memberLists = document.getElementsByClassName("tab")
   if (memberLists) {
     for (i = 0; i < memberLists.length; i++) {
       memberLists[i].children[0].onclick = function(e) {

scaladoc/resources/dotty_res/styles/theme/color-tokens.css

@@ -64,6 +64,9 @@
   --code-syntax-highlighting-deletion: var(--crimson11);
   --code-syntax-highlighting-variable: var(--purple9);
 
+  --code-syntax-highlighting-scrollbar: var(--grey8);
+  --code-syntax-highlighting-scrollbar-hover: var(--grey9);
+
   --code-method-highlighting-type: var(--purple9);
   --code-method-highlighting-type-link: var(--sky11);
   --code-method-highlighting-code-fg: var(--grey12);
@@ -142,6 +145,9 @@
   --code-syntax-highlighting-deletion: var(--crimson11);
   --code-syntax-highlighting-variable: var(--purple9);
 
+  --code-syntax-highlighting-scrollbar: var(--grey8);
+  --code-syntax-highlighting-scrollbar-hover: var(--grey9);
+
   --code-method-highlighting-type: var(--purple9);
   --code-method-highlighting-type-link: var(--sky11);
   --code-method-highlighting-code-fg: var(--grey12);

scaladoc/resources/dotty_res/styles/theme/components/code-snippet.css

@@ -167,3 +167,27 @@
 .hljs-variable {
   color: var(--code-syntax-highlighting-variable);
 }
+
+/* Scrollbar */
+
+/*   For Firefox */
+.snippet {
+  scrollbar-color: var(--code-syntax-highlighting-scrollbar);
+  scrollbar-width: thin;
+}
+
+/*   For Chrome */
+
+.snippet::-webkit-scrollbar-thumb {
+  background-color: var(--code-syntax-highlighting-scrollbar);
+  border-radius: 3px;
+}
+
+.snippet::-webkit-scrollbar-thumb:hover {
+  background-color: var(--code-syntax-highlighting-scrollbar-hover);
+}
+
+.snippet::-webkit-scrollbar {
+  width: 8px;
+  height: 8px;
+}

scaladoc/resources/dotty_res/styles/theme/components/contributors.css

@@ -157,6 +157,11 @@
   color: var(--text-primary);
 }
 
+/* content first paragraph */
+#content .first-p {
+  color: var(--text-secondary);
+}
+
 /* content list */
 #content li {
   color: var(--text-primary);
@@ -365,27 +370,27 @@
   margin-bottom: calc(3 * var(--base-spacing));
 }
 
-.membersList {
+.tab {
   position: relative;
 }
 
-.membersList h2 {
+.tab h2 {
   border-bottom: 1px solid var(--border-default);
   padding-bottom: calc(3 * var(--base-spacing));
   padding-top: calc(3 * var(--base-spacing));
 }
 
-.membersList > button {
+.tab > button {
   position: absolute;
   right: 0;
   top: calc(3.5 * var(--base-spacing));
 }
 
-.membersList .documentableList {
+.tab .documentableList {
   display: none;
 }
 
-.membersList.expand .documentableList {
+.tab.expand .documentableList {
   display: block;
 }
 

scaladoc/resources/dotty_res/styles/theme/layout/content.css

@@ -125,6 +125,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       Option.when(bodyContents.nonEmpty || attributes.nonEmpty)(
         div(cls := "cover")(
           div(cls := "doc")(bodyContents),
+          h2(cls := "h500")("Attributes"),
           dl(cls := "attributes")(attributes*)
         )
       )
@@ -260,7 +261,15 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
 
     val children = all.flatten.flatten
     if children.isEmpty then emptyTab
-    else Tab(name, name, h2(tabAttr(name), cls := "h300")(name) +: children, "selected")
+    else Tab(
+      name,
+      name,
+      Seq(
+        button(cls := "icon-button show-content expand"),
+        h2(tabAttr(name), cls := "h300")(name)
+      ) ++ children,
+      "expand"
+    )
 
   case class ExpandedGroup(name: AppliedTag, description: AppliedTag, prio: Int)
 
@@ -289,7 +298,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
             members.map(member)
           ))
       }
-      Tab("Grouped members", "custom_groups", content, "selected")
+      Tab("Grouped members", "custom_groups", content, "expand")
 
   def buildMembers(s: Member): AppliedTag =
     def partitionIntoGroups(members: Seq[Member]) =
@@ -318,7 +327,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       }.toSeq
 
     div(cls := "membersList expand")(
-    button(cls := "icon-button show-content expand"),
+    h2(cls := "h500")("Members list"),
     renderTabs(
       singleSelection = false,
       buildGroup("Packages", Seq(

scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala

@@ -78,6 +78,10 @@ trait SiteRenderer(using DocContext) extends Locations:
         }
       }
 
+    document.select("header + p").forEach(firstParagraph =>
+      firstParagraph.addClass("body-large")
+      firstParagraph.addClass("first-p")
+    )
     document.select("a").forEach(element =>
       element.attr("href", processLocalLinkWithGuard(element.attr("href")))
     )

scaladoc/src/dotty/tools/scaladoc/renderers/SiteRenderer.scala

@@ -11,7 +11,7 @@ case class SnippetLine(content: String, lineNo: Int, classes: Set[String] = Set.
   def withAttribute(name: String, value: String) = this.copy(attributes = attributes.updated(name, value))
   def toHTML =
     val label = if messages.nonEmpty then s"""label="${messages.map(_.escapeReservedTokens).mkString("\n")}"""" else ""
-    s"""<span line-number="${lineNo}" class="${classes.mkString(" ")}"><span class="tooltip-container" $label></span>$content</span>"""
+    s"""<span line-number="${lineNo + 1}" class="${classes.mkString(" ")}"><span class="tooltip-container" $label></span>$content</span>"""
 
 object SnippetRenderer:
   val hiddenStartSymbol = "//{"

scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/SnippetRenderer.scala

@@ -23,7 +23,7 @@ class SiteGeneratationTest extends BaseHtmlTest:
     parents: Seq[String] = Nil,
     checks: DocumentContext => Unit = _ => ())(using ProjectContext) =
       withHtmlFile(path){ content  =>
-        content.assertTextsIn(".project-name", projectName)
+        content.assertTextsIn(".project-name", projectName, projectName) // There are two elements with project name: one for desktop, one for mobile
         content.assertTextsIn(".projectVersion", projectVersion)
         content.assertTextsIn("h1", header)
         content.assertTextsIn("title", title)