Scaladoc: updated type class descriptions

The known type class descriptions give you a humanly-understandable
explanation for [T: TypeClass] in the implicit conversions. For
example [T: Integral] will tell you that T must be an integral type
such as Integer and co.

Now that the reflection dust settled, I can actually add the test to
make sure the well-known type classes are intercepted and explanations
are given instead of the usual "the type T is context-bounded by
TypeClass"

3 files changed, 72 insertions, 0 deletions

diff --git a/test/scaladoc/resources/implicits-known-type-classes-res.scala b/test/scaladoc/resources/implicits-known-type-classes-res.scala
new file mode 100644
index 0000000000..9ad652947d
--- /dev/null
+++ b/test/scaladoc/resources/implicits-known-type-classes-res.scala
@@ -0,0 +1,38 @@
+/** Tests the "known type classes" feature of scaladoc implicits
+ *  if the test fails, please update the correct qualified name of
+ *  the type class in src/compiler/scala/tools/nsc/doc/Settings.scala
+ *  in the knownTypeClasses map. Thank you! */
+package scala.test.scaladoc.implicits.typeclasses {
+  class A[T]
+  object A {
+    import language.implicitConversions
+    import scala.reflect.{ClassTag, TypeTag}
+    implicit def convertNumeric       [T: Numeric]       (a: A[T]) = new B(implicitly[Numeric[T]])
+    implicit def convertIntegral      [T: Integral]      (a: A[T]) = new B(implicitly[Integral[T]])
+    implicit def convertFractional    [T: Fractional]    (a: A[T]) = new B(implicitly[Fractional[T]])
+    implicit def convertManifest      [T: Manifest]      (a: A[T]) = new B(implicitly[Manifest[T]])
+    implicit def convertClassManifest [T: ClassManifest] (a: A[T]) = new B(implicitly[ClassManifest[T]])
+    implicit def convertOptManifest   [T: OptManifest]   (a: A[T]) = new B(implicitly[OptManifest[T]])
+    implicit def convertClassTag      [T: ClassTag]      (a: A[T]) = new B(implicitly[ClassTag[T]])
+    implicit def convertTypeTag       [T: TypeTag]       (a: A[T]) = new B(implicitly[TypeTag[T]])
+    type K[X] = Numeric[X]
+    type L[X] = Integral[X]
+    type M[X] = Fractional[X]
+    type N[X] = Manifest[X]
+    type O[X] = ClassManifest[X]
+    type P[X] = OptManifest[X]
+    type Q[X] = ClassTag[X]
+    type R[X] = TypeTag[X]
+    implicit def convertK [T: K] (a: A[T]) = new B(implicitly[K[T]])
+    implicit def convertL [T: L] (a: A[T]) = new B(implicitly[L[T]])
+    implicit def convertM [T: M] (a: A[T]) = new B(implicitly[M[T]])
+    implicit def convertN [T: N] (a: A[T]) = new B(implicitly[N[T]])
+    implicit def convertO [T: O] (a: A[T]) = new B(implicitly[O[T]])
+    implicit def convertP [T: P] (a: A[T]) = new B(implicitly[P[T]])
+    implicit def convertQ [T: Q] (a: A[T]) = new B(implicitly[Q[T]])
+    implicit def convertR [T: R] (a: A[T]) = new B(implicitly[R[T]])
+  }
+  class B[T](t: T) {
+    def typeClass: T = t
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/implicits-known-type-classes.check b/test/scaladoc/run/implicits-known-type-classes.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/implicits-known-type-classes.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/implicits-known-type-classes.scala b/test/scaladoc/run/implicits-known-type-classes.scala
new file mode 100644
index 0000000000..9f4ca372b0
--- /dev/null
+++ b/test/scaladoc/run/implicits-known-type-classes.scala
@@ -0,0 +1,33 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+import language._
+
+object Test extends ScaladocModelTest {
+
+  // test a file instead of a piece of code
+  override def resourceFile = "implicits-known-type-classes-res.scala"
+
+  // start implicits
+  def scaladocSettings = "-implicits"
+
+  def testModel(root: Package) = {
+    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
+    import access._
+
+    /** Tests the "known type classes" feature of scaladoc implicits
+     *  if the test fails, please update the correct qualified name of
+     *  the type class in src/compiler/scala/tools/nsc/doc/Settings.scala
+     *  in the knownTypeClasses map. Thank you! */
+
+    val base = root._package("scala")._package("test")._package("scaladoc")._package("implicits")._package("typeclasses")
+    var conv: ImplicitConversion = null
+
+    val A = base._class("A")
+
+    for (conversion <- A.conversions if !conversion.isCommonConversion) {
+      assert(conversion.constraints.length == 1, conversion.constraints.length + " == 1 (in " + conversion + ")")
+      assert(conversion.constraints.head.isInstanceOf[KnownTypeClassConstraint],
+             conversion.constraints.head + " is not a known type class constraint!")
+    }
+  }
+}