Skip to content

Commit 86b4135

Browse files
committed
Restore scaladoc markdown syntax and snippet compiler config
1 parent d96e9e3 commit 86b4135

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
@@ -4095,26 +4095,37 @@ object ScaladocConfigs {
40954095
}
40964096

40974097
lazy val Scala3 = Def.task {
4098+
val stdlib = { // relative path to the stdlib directory ('library/')
4099+
val projectRoot = (ThisBuild/baseDirectory).value.toPath
4100+
val stdlibRoot = (`scala-library-bootstrapped` / baseDirectory).value
4101+
projectRoot.relativize(stdlibRoot.toPath.normalize())
4102+
}
4103+
40984104
DefaultGenerationSettings.value
40994105
.add(ProjectName("Scala 3"))
41004106
.add(OutputDir(file("scaladoc/output/scala3").getAbsoluteFile.getAbsolutePath))
41014107
.add(Revision("main"))
41024108
.add(ExternalMappings(List(javaExternalMapping)))
4103-
.add(DocRootContent(((`scala-library-bootstrapped` / baseDirectory).value / "src" / "rootdoc.txt").toString))
4109+
.add(DocRootContent((stdlib / "src" / "rootdoc.txt").toString))
41044110
.add(CommentSyntax(List(
4105-
//s"${dottyLibRoot}=markdown",
4106-
//s"${stdLibRoot}=wiki",
4111+
// Only the files below use markdown syntax (Scala 3 specific sources)
4112+
s"$stdlib/src/scala/NamedTuple.scala=markdown",
4113+
s"$stdlib/src/scala/Tuple.scala=markdown",
4114+
s"$stdlib/src/scala/compiletime=markdown",
4115+
s"$stdlib/src/scala/quoted=markdown",
4116+
s"$stdlib/src/scala/util/boundary.scala=markdown",
4117+
// Scala 2 sources use wiki syntax, we keep it as the default
41074118
"wiki"
41084119
)))
41094120
.add(VersionsDictionaryUrl("https://scala-lang.org/api/versions.json"))
41104121
.add(DocumentSyntheticTypes(true))
4111-
//.add(SnippetCompiler(List(
4112-
//s"$dottyLibRoot/src/scala=compile",
4113-
//s"$dottyLibRoot/src/scala/quoted=compile",
4114-
//s"$dottyLibRoot/src/scala/compiletime=compile",
4115-
//s"$dottyLibRoot/src/scala/util=compile",
4116-
//s"$dottyLibRoot/src/scala/util/control=compile"
4117-
//)))
4122+
.add(SnippetCompiler(List(
4123+
s"$stdlib/src/scala/compiletime=compile",
4124+
s"$stdlib/src/scala/quoted=compile",
4125+
s"$stdlib/src/scala/util/control=compile",
4126+
s"$stdlib/src/scala/util=compile",
4127+
s"$stdlib/src/scala=compile",
4128+
)))
41184129
.add(SiteRoot("docs"))
41194130
.add(ApiSubdirectory(true))
41204131
.withTargets((`scala-library-bootstrapped` / Compile / products).value.map(_.getAbsolutePath))

0 commit comments

Comments
 (0)