summaryrefslogtreecommitdiff
path: root/src/reflect/scala/reflect/runtime/package.scala
diff options
context:
space:
mode:
authorHeather Miller <heather.miller@epfl.ch>2012-10-11 20:31:42 +0200
committerHeather Miller <heather.miller@epfl.ch>2012-10-11 20:31:42 +0200
commite95a00992599f59f7c74bcc171bb290f859ab848 (patch)
treefcafe4836f532311790b32c46180c4222fd933b7 /src/reflect/scala/reflect/runtime/package.scala
parentb55ca84dbc34f3337d4e95df3a045156d71f77d7 (diff)
downloadscala-e95a00992599f59f7c74bcc171bb290f859ab848.tar.gz
scala-e95a00992599f59f7c74bcc171bb290f859ab848.tar.bz2
scala-e95a00992599f59f7c74bcc171bb290f859ab848.zip
Adds lots of new documentation for TypeTags, Mirrors, Universes and more
Additionally includes improvements, formatting fixes, and link additions and fixes.
Diffstat (limited to 'src/reflect/scala/reflect/runtime/package.scala')
-rw-r--r--src/reflect/scala/reflect/runtime/package.scala12
1 files changed, 8 insertions, 4 deletions
diff --git a/src/reflect/scala/reflect/runtime/package.scala b/src/reflect/scala/reflect/runtime/package.scala
index b3f9ba5817..b97913daf0 100644
--- a/src/reflect/scala/reflect/runtime/package.scala
+++ b/src/reflect/scala/reflect/runtime/package.scala
@@ -5,14 +5,18 @@ package scala.reflect
*/
package object runtime {
- /** The entry point into runtime reflection.
- * See [[scala.reflect.api.package the overview page]] for details on how to use it.
+ /** The entry point into Scala runtime reflection.
+ *
+ * To use Scala runtime reflection, simply use or import `scala.reflect.runtime.universe._`
+ *
+ * See [[scala.reflect.api.Universe]] or the
+ * [[http://docs.scala-lang.org/overviews/reflection/environment-universes-mirrors.html Reflection Guide: Universes]]
+ * for more details.
*/
lazy val universe: api.JavaUniverse = new runtime.JavaUniverse
/** The runtime reflection mirror that corresponds to the current lexical context.
- * Is typically equivalent to `universe.runtimeMirror(getClass.getClassLoader)` invoked at the call site.
- * See [[scala.reflect.api.package the overview page]] for details on how to use it.
+ * It's typically equivalent to `universe.runtimeMirror(getClass.getClassLoader)` invoked at the call site.
*/
// implementation hardwired to the `currentMirror` method below
// using the mechanism implemented in `scala.tools.reflect.FastTrack`