Skip to content

Commit 29f364d

Browse files
Dedelweissckipp01
authored andcommitted
Corrections
- Change SocialLinks and do a match case - Rephrase ScaladocSetting for custom
1 parent 9f7d1d3 commit 29f364d

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

scaladoc/src/dotty/tools/scaladoc/ScaladocSettings.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ class ScaladocSettings extends SettingGroup with AllScalaSettings:
4343

4444
val socialLinks: Setting[List[String]] =
4545
MultiStringSetting("-social-links", "social-links",
46-
"Links to social sites. '[github|twitter|gitter|discord]::link' syntax is used." +
47-
"'custom::link::white_icon_name::black_icon_name' is also allowed, in this case icons must be present in 'images/'' directory.")
46+
"Links to social sites. '[github|twitter|gitter|discord]::link' or 'custom::link::light_icon_file_name[::dark_icon_file_name]' syntax is used. For custom links, the icons must be present in '_assets/images/'")
4847

4948
val deprecatedSkipPackages: Setting[List[String]] =
5049
MultiStringSetting("-skip-packages", "packages", "Deprecated, please use `-skip-by-id` or `-skip-by-regex`")

scaladoc/src/dotty/tools/scaladoc/SocialLinks.scala

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ import java.nio.file.Path
44
import java.nio.file.Paths
55
import dotty.tools.dotc.core.Contexts.Context
66

7-
enum SocialLinks(val url: String, val whiteIcon: String, val darkIcon: String, val className: String):
8-
case Github(ghUrl: String) extends SocialLinks(ghUrl, "", "", "gh")
9-
case Twitter(tUrl: String) extends SocialLinks(tUrl, "", "", "twitter")
10-
case Gitter(gUrl: String) extends SocialLinks(gUrl, "", "", "gitter")
11-
case Discord(dUrl: String) extends SocialLinks(dUrl, "", "", "discord")
12-
case Custom(cUrl: String, firstIcon: String, secondIcon: String) extends SocialLinks(cUrl, firstIcon, secondIcon, "custom")
7+
enum SocialLinks(val url: String, val className: String):
8+
case Github(ghUrl: String) extends SocialLinks(ghUrl, "gh")
9+
case Twitter(tUrl: String) extends SocialLinks(tUrl, "twitter")
10+
case Gitter(gUrl: String) extends SocialLinks(gUrl, "gitter")
11+
case Discord(dUrl: String) extends SocialLinks(dUrl, "discord")
12+
case Custom(cUrl: String, lightIcon: String, darkIcon: String) extends SocialLinks(cUrl, "custom")
1313

1414
object SocialLinks:
1515
def parse(s: String): Either[String, SocialLinks] =

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,14 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
166166
def icon(link: SocialLinks) = link.className
167167
args.socialLinks.map { link =>
168168
a(href := link.url) (
169-
if icon(link) == "custom" then
170-
Seq(
171-
img(cls := s"icon-button ${icon(link)}", src := s"../../../../images/${link.whiteIcon}"),
172-
img(cls := s"icon-button ${icon(link)}-dark", src := s"../../../../images/${link.darkIcon}")
173-
)
174-
else
175-
button(cls := s"icon-button ${icon(link)}")
169+
link match
170+
case SocialLinks.Custom(_, lightIcon, darkIcon) =>
171+
Seq(
172+
img(cls := s"icon-button ${icon(link)}", src := s"../../../../images/$lightIcon"),
173+
img(cls := s"icon-button ${icon(link)}-dark", src := s"../../../images/$darkIcon")
174+
)
175+
case _ =>
176+
button(cls := s"icon-button ${icon(link)}")
176177
)
177178
}
178179

0 commit comments

Comments
 (0)