Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

scaladoc warning "undefined variable" in code examples using string interpolation #9815

Open
scabug opened this issue Jun 14, 2016 · 3 comments

Comments

@scabug
Copy link

scabug commented Jun 14, 2016

/**
 * {{{
 * val name = "bob"
 * val x = s"hi, $name"
 * }}}
 */
class C

gives a warning when running scaladoc:

Test.scala:4: warning: Variable name undefined in comment for class C in class C
 * val x = s"hi, $name"
                  ^
one warning found
@scabug
Copy link
Author

scabug commented Jun 14, 2016

Imported From: https://issues.scala-lang.org/browse/SI-9815?orig=1
Reporter: @lrytz
Affected Versions: 2.12.0-M4

@som-snytt
Copy link

This says to use backslash escape. https://stackoverflow.com/a/18179033/1296806

@som-snytt
Copy link

Turn off define substitution in code blocks

via linked ticket

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants