diff options
| author | Adriaan Moors <adriaan.moors@typesafe.com> | 2013-10-07 16:43:05 -0700 |
|---|---|---|
| committer | Adriaan Moors <adriaan.moors@typesafe.com> | 2013-10-07 16:43:05 -0700 |
| commit | acd77803f7da7c369f4ffdc70b5eeec4a23e35ae (patch) | |
| tree | 90e18dfca98e490e350d29c674cd3f8c2209ef7b /src | |
| parent | 90a312669b37d6e3e3f08685953ded24759e6102 (diff) | |
| parent | 9835d33da7c98feb2f1917b0694d1628d675262a (diff) | |
| download | scala-acd77803f7da7c369f4ffdc70b5eeec4a23e35ae.tar.gz scala-acd77803f7da7c369f4ffdc70b5eeec4a23e35ae.tar.bz2 scala-acd77803f7da7c369f4ffdc70b5eeec4a23e35ae.zip | |
Merge pull request #3014 from ceedubs/pr/implicitNotFound-scaladoc
Describe type parameter interpolation in @implicitNotFound documentation
Diffstat (limited to 'src')
| -rw-r--r-- | src/library/scala/annotation/implicitNotFound.scala | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/library/scala/annotation/implicitNotFound.scala b/src/library/scala/annotation/implicitNotFound.scala index bbde90cebb..eeedcb014e 100644 --- a/src/library/scala/annotation/implicitNotFound.scala +++ b/src/library/scala/annotation/implicitNotFound.scala @@ -9,8 +9,11 @@ package scala.annotation /** - * An annotation that specifies the error message that is emitted when the compiler - * cannot find an implicit value of the annotated type. + * To customize the error message that's emitted when an implicit of type + * C[T1,..., TN] cannot be found, annotate the class C with @implicitNotFound. + * Assuming C has type parameters X1,..., XN, the error message will be the + * result of replacing all occurrences of ${Xi} in the string msg with the + * string representation of the corresponding type argument Ti. * * * @author Adriaan Moors * @since 2.8.1 |