Skip to content

Commit 294a9af

Browse files
committed
Add missing reference docs for Toolkit directives
1 parent 81a8f04 commit 294a9af

File tree

3 files changed

+73
-6
lines changed

3 files changed

+73
-6
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ import scala.build.options.*
1313
import scala.cli.commands.SpecificationLevel
1414

1515
@DirectiveGroupName("Toolkit")
16-
@DirectiveExamples("//> using toolkit 0.1.0")
16+
@DirectiveExamples(s"//> using toolkit ${Constants.toolkitDefaultVersion}")
1717
@DirectiveExamples("//> using toolkit default")
1818
@DirectiveExamples("//> using test.toolkit default")
1919
@DirectiveUsage(
2020
"//> using toolkit _version_",
21-
"`//> using toolkit` _version_"
21+
"""`//> using toolkit` _version_
22+
|
23+
|//> using test.toolkit` _version_
24+
|""".stripMargin
2225
)
2326
@DirectiveDescription(
2427
s"Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for Scala toolkit: ${Constants.toolkitDefaultVersion}, 'default' version for typelevel toolkit: ${Constants.typelevelToolkitDefaultVersion}"

website/docs/reference/directives.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,13 +474,42 @@ Add Scala Native options
474474
`//> using nativeClang` _value_
475475

476476
`//> using nativeClangPP` _value_
477+
`//> using nativeClangPp` _value_
477478

478479
`//> using nativeEmbedResources` _true|false_
480+
`//> using nativeEmbedResources`
479481

480482
`//> using nativeTarget` _application|library-dynamic|library-static_
481483

484+
`//> using nativeMultithreading` _true|false_
485+
`//> using nativeMultithreading`
486+
482487
#### Examples
483-
`//> using nativeVersion 0.4.0`
488+
`//> using nativeGc immix`
489+
490+
`//> using nativeMode debug`
491+
492+
`//> using nativeLto full`
493+
494+
`//> using nativeVersion 0.5.7`
495+
496+
`//> using nativeCompile -flto=thin`
497+
498+
`//> using nativeLinking -flto=thin`
499+
500+
`//> using nativeClang ./clang`
501+
502+
`//> using nativeClangPP ./clang++`
503+
504+
`//> using nativeEmbedResources`
505+
506+
`//> using nativeEmbedResources true`
507+
508+
`//> using nativeTarget library-dynamic`
509+
510+
`//> using nativeMultithreading`
511+
512+
`//> using nativeMultithreading false`
484513

485514
### Scala version
486515

@@ -592,8 +621,11 @@ Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for
592621

593622
`//> using toolkit` _version_
594623

624+
//> using test.toolkit` _version_
625+
626+
595627
#### Examples
596-
`//> using toolkit 0.1.0`
628+
`//> using toolkit 0.7.0`
597629

598630
`//> using toolkit default`
599631

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

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,13 +297,42 @@ Add Scala Native options
297297
`//> using nativeClang` _value_
298298

299299
`//> using nativeClangPP` _value_
300+
`//> using nativeClangPp` _value_
300301

301302
`//> using nativeEmbedResources` _true|false_
303+
`//> using nativeEmbedResources`
302304

303305
`//> using nativeTarget` _application|library-dynamic|library-static_
304306

307+
`//> using nativeMultithreading` _true|false_
308+
`//> using nativeMultithreading`
309+
305310
#### Examples
306-
`//> using nativeVersion 0.4.0`
311+
`//> using nativeGc immix`
312+
313+
`//> using nativeMode debug`
314+
315+
`//> using nativeLto full`
316+
317+
`//> using nativeVersion 0.5.7`
318+
319+
`//> using nativeCompile -flto=thin`
320+
321+
`//> using nativeLinking -flto=thin`
322+
323+
`//> using nativeClang ./clang`
324+
325+
`//> using nativeClangPP ./clang++`
326+
327+
`//> using nativeEmbedResources`
328+
329+
`//> using nativeEmbedResources true`
330+
331+
`//> using nativeTarget library-dynamic`
332+
333+
`//> using nativeMultithreading`
334+
335+
`//> using nativeMultithreading false`
307336

308337
### Scala.js options
309338

@@ -400,8 +429,11 @@ Use a toolkit as dependency (not supported in Scala 2.12), 'default' version for
400429

401430
`//> using toolkit` _version_
402431

432+
//> using test.toolkit` _version_
433+
434+
403435
#### Examples
404-
`//> using toolkit 0.1.0`
436+
`//> using toolkit 0.7.0`
405437

406438
`//> using toolkit default`
407439

0 commit comments

Comments
 (0)