Skip to content

Commit 60847c0

Browse files
committed
Improve boundary doc comment
1 parent 25efae1 commit 60847c0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

library/src/scala/util/boundary.scala

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ object boundary:
3333
/*message*/ null, /*cause*/ null, /*enableSuppression=*/ false, /*writableStackTrace*/ false)
3434

3535
/** Labels are targets indicating which boundary will be exited by a `break`.
36+
* A Label is generated and passed to code wrapped in a `boundary` call. Example
37+
*
38+
* boundary[Unit]:
39+
* ...
40+
* summon[Label[Unit]] // will link to the label generated by `boundary`
3641
*/
3742
final class Label[-T]
3843

0 commit comments

Comments
 (0)