Skip to content

Commit 97de19b

Browse files
committed
Add example testcases for CommentSyntax option in Scaladoc
Those consist of packages example.comment.md and example.comment.wiki configured with a matching comment syntax.
1 parent 941b7b8 commit 97de19b

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

project/Build.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1801,6 +1801,10 @@ object ScaladocConfigs {
18011801
.add(Revision("main"))
18021802
.add(SnippetCompiler(List("scaladoc-testcases/docs=compile")))
18031803
.add(SiteRoot("scaladoc-testcases/docs"))
1804+
.add(CommentSyntax(List(
1805+
"scaladoc-testcases/src/example/comment-md=markdown",
1806+
"scaladoc-testcases/src/example/comment-wiki=wiki"
1807+
)))
18041808
.add(ExternalMappings(List(dottyExternalMapping, javaExternalMapping)))
18051809
.withTargets(tastyRoots)
18061810
}

project/scripts/cmdScaladocTests

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ dist/target/pack/bin/scaladoc \
3535
"-skip-by-id:scala.runtime.stdLibPatches" \
3636
"-skip-by-id:scala.runtime.MatchCase" \
3737
"-snippet-compiler:scaladoc-testcases/docs=compile" \
38+
"-comment-syntax:scaladoc-testcases/src/example/comment-md=markdown,scaladoc-testcases/src/example/comment-wiki=wiki" \
3839
-siteroot scaladoc-testcases/docs \
3940
-project-footer "Copyright (c) 2002-2022, LAMP/EPFL" \
4041
-default-template static-site-main \
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package example.comment.md
2+
/**
3+
* # markdown header
4+
* Markdown syntax is used here.
5+
*/
6+
object CommentExample
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package example.comment.wiki
2+
/**
3+
* = wiki header =
4+
* Wiki syntax is used here.
5+
*/
6+
object CommentExample

0 commit comments

Comments
 (0)