Skip to content

Commit 15879c9

Browse files
committed
API members styles refinement
1 parent b03b9a4 commit 15879c9

File tree

5 files changed

+65
-27
lines changed

5 files changed

+65
-27
lines changed

scaladoc/resources/dotty_res/styles/theme/components/api-member.css

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,27 @@
1515
line-height: 1.5;
1616
}
1717

18-
.documentableElement:hover {
18+
.documentableElement:not(.expand):hover,
19+
.documentableElement-expander {
1920
cursor: pointer;
2021
}
2122

2223
.documentableElement .documentableBrief {
2324
color: var(--text-secondary);
2425
}
2526

26-
.documentableElement .documentableBrief > p {
27-
margin: 4px 0 0;
27+
.documentableElement .documentableBrief p:first-of-type,
28+
.documentableElement.expand > div .cover .doc p:first-of-type {
29+
margin-block: calc(.5 * var(--base-spacing)) 0;
30+
}
31+
32+
.documentableElement .doc p,
33+
.documentableElement .doc .snippet {
34+
margin-block: calc(2 * var(--base-spacing));
35+
}
36+
37+
.documentableElement.expand .doc > :last-child {
38+
margin-block-end: 0;
2839
}
2940

3041
.documentableElement .annotations {
@@ -41,7 +52,18 @@ color: var(--text-secondary);
4152

4253
.documentableElement.expand > div .cover {
4354
display: block;
55+
}
4456

57+
.attributes.attributes-small > dt {
58+
padding-block: calc(1.5 * var(--base-spacing));
59+
}
60+
61+
.attributes.attributes-small > dd {
62+
padding-block: calc(1 * var(--base-spacing));
63+
}
64+
65+
.documentableElement.expand {
66+
padding-block-end: calc(4 * var(--base-spacing));
4567
}
4668

4769
.documentableElement.expand > div .cover dd {
@@ -62,7 +84,8 @@ color: var(--text-secondary);
6284

6385
.documentableElement .icon-button {
6486
position: absolute;
65-
left: -28px
87+
left: calc(3.5 * var(--base-spacing) / -1);
88+
top: calc(2 * var(--base-spacing));
6689
}
6790

6891
.documentableElement:hover .icon-button {

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,23 @@
1212
}
1313

1414
.attributes p {
15-
margin: 0;
15+
margin-block: calc(3 * var(--base-spacing));
16+
}
17+
18+
.attributes p:has(span:empty) {
19+
display: none;
20+
}
21+
22+
.membersList .attributes p {
23+
margin-block: calc(1 * var(--base-spacing));
24+
}
25+
26+
.attributes p:first-child {
27+
margin-block-start: 0;
28+
}
29+
30+
.attributes p:last-child {
31+
margin-block-end: 0;
1632
}
1733

1834
.attributes > dt {

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ body {
77
}
88

99
p {
10-
margin-block-start: calc(3 * var(--base-spacing));
11-
margin-block-end: calc(3 * var(--base-spacing));
10+
margin-block: calc(3 * var(--base-spacing));
1211
}
1312

1413
[id] {

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ class DocRender(signatureRenderer: SignatureRenderer)(using DocContext):
5757
case Title(text, level) =>
5858
val content = renderElement(text)
5959
level match
60-
case 1 => h1(cls := "h500")(content)
61-
case 2 => h2(cls := "h300")(content)
62-
case 3 => h3(cls := "h200")(content)
63-
case 4 => h4(cls := "h100")(content)
64-
case 5 => h5(cls := "h50")(content)
65-
case 6 => h6(cls := "h50")(content)
60+
case 1 => h1(cls := "h600")(content)
61+
case 2 => h2(cls := "h500")(content)
62+
case 3 => h3(cls := "h400")(content)
63+
case 4 => h4(cls := "h300")(content)
64+
case 5 => h5(cls := "h200")(content)
65+
case 6 => h6(cls := "h100")(content)
6666
case Paragraph(text) => p(renderElement(text))
6767
case Code(data: String) => raw(SnippetRenderer.renderSnippet(data))
6868
case HorizontalRule => hr

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,26 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
5353
def authors(authors: List[DocPart]) = if summon[DocContext].args.includeAuthors then list("Authors:", authors) else Nil
5454

5555
m.docs.fold(Nil)(d =>
56-
opt("Returns:", d.result) ++
57-
list("Throws:", d.throws) ++
58-
opt("Constructor:", d.constructor) ++
56+
opt("Returns", d.result) ++
57+
list("Throws", d.throws) ++
58+
opt("Constructor", d.constructor) ++
5959
authors(d.authors) ++
60-
list("See also:", d.see) ++
61-
opt("Version:", d.version) ++
62-
opt("Since:", d.since) ++
63-
list("Todo:", d.todo) ++
64-
list("Note:", d.note) ++
65-
list("Example:", d.example)
60+
list("See also", d.see) ++
61+
opt("Version", d.version) ++
62+
opt("Since", d.since) ++
63+
list("Todo", d.todo) ++
64+
list("Note", d.note) ++
65+
list("Example", d.example)
6666
)
6767

6868
def companion(m: Member): Seq[AppliedTag] = m.companion.fold(Nil){ (kind, dri) =>
6969
val kindName = kind.name
70-
tableRow("Companion:", signatureRenderer.renderLink(kindName, dri))
70+
tableRow("Companion", signatureRenderer.renderLink(kindName, dri))
7171
}
7272

7373
def source(m: Member): Seq[AppliedTag] =
7474
summon[DocContext].sourceLinks.pathTo(m).fold(Nil){ link =>
75-
tableRow("Source:", a(href := link)(m.sources.fold("(source)")(_.path.getFileName().toString())))
75+
tableRow("Source", a(href := link)(m.sources.fold("(source)")(_.path.getFileName().toString())))
7676
}
7777

7878
def deprecation(m: Member): Seq[AppliedTag] = m.deprecated.fold(Nil){ a =>
@@ -176,7 +176,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
176176

177177
val signature: MemberSignature = signatureProvider.rawSignature(member)()
178178
Seq(
179-
div(cls := "signature mono-small-block")(
179+
div(cls := "signature")(
180180
span(cls := "modifiers")(signature.prefix.map(renderElement(_))),
181181
span(cls := "kind")(signature.kind.map(renderElement(_))),
182182
signature.name.map(renderElement(_, nameClasses*)),
@@ -216,7 +216,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
216216
div(cls := "documentableElement-expander")(
217217
Option.when(annots.nonEmpty || originInf.nonEmpty || memberInf.nonEmpty)(button(cls := "icon-button ar show-content")).toList,
218218
annots.map(div(_)).toList,
219-
div(cls := "header monospace")(memberSignature(member)),
219+
div(cls := "header monospace mono-medium")(memberSignature(member)),
220220
),
221221
Option.when(originInf.nonEmpty || memberInf.nonEmpty)(
222222
div(cls := "docs")(
@@ -232,7 +232,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
232232
private case class MGroup(header: AppliedTag, members: Seq[Member], groupName: String)
233233

234234
private def makeSubgroupHeader(name: String): AppliedTag =
235-
h4(cls := "groupHeader h300")(name)
235+
h4(cls := "groupHeader h200")(name)
236236

237237
private def actualGroup(name: String, members: Seq[Member | MGroup], headerConstructor: String => AppliedTag = makeSubgroupHeader, wrapInSection: Boolean = true): Seq[AppliedTag] =
238238
if members.isEmpty then Nil else

0 commit comments

Comments
 (0)