Skip to content

Commit 45f163a

Browse files
committed
Add missing reference docs for JMH directives
1 parent 294a9af commit 45f163a

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ import scala.build.{Positioned, options}
1616
import scala.cli.commands.SpecificationLevel
1717

1818
@DirectiveGroupName("Benchmarking options")
19+
@DirectiveExamples(s"//> using jmh")
20+
@DirectiveExamples(s"//> using jmh true")
1921
@DirectiveExamples(s"//> using jmhVersion ${Constants.jmhVersion}")
2022
@DirectiveUsage(
2123
"//> using jmh _value_ | using jmhVersion _value_",

website/docs/reference/directives.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Add benchmarking options
1414
`//> using jmhVersion` _value_
1515

1616
#### Examples
17+
`//> using jmh`
18+
19+
`//> using jmh true`
20+
1721
`//> using jmhVersion 1.37`
1822

1923
### BuildInfo

0 commit comments

Comments
 (0)