Skip to content

Commit bee68ef

Browse files
committed
Add missing reference docs for *.option directives
1 parent eb00a49 commit bee68ef

File tree

3 files changed

+39
-7
lines changed

3 files changed

+39
-7
lines changed

modules/directives/src/main/scala/scala/build/preprocessing/directives/ScalacOptions.scala

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,33 @@ import scala.cli.commands.SpecificationLevel
1616

1717
@DirectiveGroupName("Compiler options")
1818
@DirectiveExamples("//> using option -Xasync")
19-
@DirectiveExamples("//> using test.option -Xasync")
2019
@DirectiveExamples("//> using options -Xasync -Xfatal-warnings")
20+
@DirectiveExamples("//> using test.option -Xasync")
21+
@DirectiveExamples("//> using test.options -Xasync -Xfatal-warnings")
2122
@DirectiveUsage(
2223
"using option _option_ | using options _option1_ _option2_ …",
23-
"""`//> using option` _option_
24+
"""`//> using scalacOption` _option_
25+
|`//> using option` _option_
26+
|`//> using scalacOptions` _option1_ _option2_ …
27+
|`//> using options` _option1_ _option2_ …
28+
|
29+
|`//> using test.scalacOption` _option_
30+
|`//> using test.option` _option_
31+
|`//> using test.scalacOptions` _option1_ _option2_ …
32+
|`//> using test.options` _option1_ _option2_ …
2433
|
25-
|`//> using options` _option1_ _option2_ …""".stripMargin
34+
|""".stripMargin
2635
)
2736
@DirectiveDescription("Add Scala compiler options")
2837
@DirectiveLevel(SpecificationLevel.MUST)
2938
final case class ScalacOptions(
3039
@DirectiveName("option")
40+
@DirectiveName("scalacOption")
41+
@DirectiveName("scalacOptions")
3142
options: List[Positioned[String]] = Nil,
3243
@DirectiveName("test.option")
3344
@DirectiveName("test.options")
45+
@DirectiveName("test.scalacOption")
3446
@DirectiveName("test.scalacOptions")
3547
testOptions: List[Positioned[String]] = Nil
3648
) extends HasBuildOptionsWithRequirements {

website/docs/reference/directives.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,26 @@ Generate BuildInfo for project
2929

3030
Add Scala compiler options
3131

32+
`//> using scalacOption` _option_
3233
`//> using option` _option_
33-
34+
`//> using scalacOptions` _option1_ _option2_
3435
`//> using options` _option1_ _option2_
3536

37+
`//> using test.scalacOption` _option_
38+
`//> using test.option` _option_
39+
`//> using test.scalacOptions` _option1_ _option2_
40+
`//> using test.options` _option1_ _option2_
41+
42+
43+
3644
#### Examples
3745
`//> using option -Xasync`
3846

47+
`//> using options -Xasync -Xfatal-warnings`
48+
3949
`//> using test.option -Xasync`
4050

41-
`//> using options -Xasync -Xfatal-warnings`
51+
`//> using test.options -Xasync -Xfatal-warnings`
4252

4353
### Compiler plugins
4454

website/docs/reference/scala-command/directives.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,26 @@ Documentation is split into sections in the spirit of RFC keywords (`MUST`, `SHO
1515

1616
Add Scala compiler options
1717

18+
`//> using scalacOption` _option_
1819
`//> using option` _option_
19-
20+
`//> using scalacOptions` _option1_ _option2_
2021
`//> using options` _option1_ _option2_
2122

23+
`//> using test.scalacOption` _option_
24+
`//> using test.option` _option_
25+
`//> using test.scalacOptions` _option1_ _option2_
26+
`//> using test.options` _option1_ _option2_
27+
28+
29+
2230
#### Examples
2331
`//> using option -Xasync`
2432

33+
`//> using options -Xasync -Xfatal-warnings`
34+
2535
`//> using test.option -Xasync`
2636

27-
`//> using options -Xasync -Xfatal-warnings`
37+
`//> using test.options -Xasync -Xfatal-warnings`
2838

2939
### Compiler plugins
3040

0 commit comments

Comments
 (0)