Skip to content

Commit

Permalink
Merge pull request #10636 from som-snytt/tweak/7349-opt-followup
Browse files Browse the repository at this point in the history
Tweak inline doc
  • Loading branch information
lrytz committed Dec 18, 2023
2 parents df7a840 + aaa19a0 commit dfe9be3
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/library/scala/inline.scala
Expand Up @@ -16,12 +16,13 @@ package scala
* An annotation for methods that the optimizer should inline.
*
* Note that by default, the Scala optimizer is disabled and no callsites are inlined. See
* `-opt:help` for information on how to enable the optimizer and inliner.
* `-opt:help` and [[https://docs.scala-lang.org/overviews/compiler-options/optimizer.html the overview document]]
* for information on how to enable the optimizer and inliner.
*
* When inlining is enabled, the inliner will always try to inline methods or callsites annotated
* `@inline` (under the condition that inlining from the defining class is allowed, see
* `-opt-inline-from:help`). If inlining is not possible, for example because the method is not
* final, an optimizer warning will be issued. See `-opt-warnings:help` for details.
* `@inline` (under the condition that inlining from the defining class is allowed).
* If inlining is not possible, for example because the method is not
* final, an optimizer warning will be issued. See `-Wopt:help` for details.
*
* Examples:
*
Expand Down

0 comments on commit dfe9be3

Please sign in to comment.