Skip to content

Commit a2f85ff

Browse files
committed
Restore scaladoc markdown syntax and snippet compiler config
1 parent d5cda61 commit a2f85ff

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

project/Build.scala

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4169,26 +4169,37 @@ object ScaladocConfigs {
41694169
}
41704170

41714171
lazy val Scala3 = Def.task {
4172+
val stdlib = { // relative path to the stdlib directory ('library/')
4173+
val projectRoot = (ThisBuild/baseDirectory).value.toPath
4174+
val stdlibRoot = (`scala-library-bootstrapped` / baseDirectory).value
4175+
projectRoot.relativize(stdlibRoot.toPath.normalize())
4176+
}
4177+
41724178
DefaultGenerationSettings.value
41734179
.add(ProjectName("Scala 3"))
41744180
.add(OutputDir(file("scaladoc/output/scala3").getAbsoluteFile.getAbsolutePath))
41754181
.add(Revision("main"))
41764182
.add(ExternalMappings(List(javaExternalMapping)))
4177-
.add(DocRootContent(((`scala-library-bootstrapped` / baseDirectory).value / "src" / "rootdoc.txt").toString))
4183+
.add(DocRootContent((stdlib / "src" / "rootdoc.txt").toString))
41784184
.add(CommentSyntax(List(
4179-
//s"${dottyLibRoot}=markdown",
4180-
//s"${stdLibRoot}=wiki",
4185+
// Only the files below use markdown syntax (Scala 3 specific sources)
4186+
s"$stdlib/src/scala/NamedTuple.scala=markdown",
4187+
s"$stdlib/src/scala/Tuple.scala=markdown",
4188+
s"$stdlib/src/scala/compiletime=markdown",
4189+
s"$stdlib/src/scala/quoted=markdown",
4190+
s"$stdlib/src/scala/util/boundary.scala=markdown",
4191+
// Scala 2 sources use wiki syntax, we keep it as the default
41814192
"wiki"
41824193
)))
41834194
.add(VersionsDictionaryUrl("https://scala-lang.org/api/versions.json"))
41844195
.add(DocumentSyntheticTypes(true))
4185-
//.add(SnippetCompiler(List(
4186-
//s"$dottyLibRoot/src/scala=compile",
4187-
//s"$dottyLibRoot/src/scala/quoted=compile",
4188-
//s"$dottyLibRoot/src/scala/compiletime=compile",
4189-
//s"$dottyLibRoot/src/scala/util=compile",
4190-
//s"$dottyLibRoot/src/scala/util/control=compile"
4191-
//)))
4196+
.add(SnippetCompiler(List(
4197+
s"$stdlib/src/scala/compiletime=compile",
4198+
s"$stdlib/src/scala/quoted=compile",
4199+
s"$stdlib/src/scala/util/control=compile",
4200+
s"$stdlib/src/scala/util=compile",
4201+
s"$stdlib/src/scala=compile",
4202+
)))
41924203
.add(SiteRoot("docs"))
41934204
.add(ApiSubdirectory(true))
41944205
.withTargets((`scala-library-bootstrapped` / Compile / products).value.map(_.getAbsolutePath))

0 commit comments

Comments
 (0)