summaryrefslogtreecommitdiff
path: root/src/reflect/scala/reflect/runtime/package.scala
diff options
context:
space:
mode:
authorEugene Burmako <xeno.by@gmail.com>2012-10-04 07:37:41 +0200
committerEugene Burmako <xeno.by@gmail.com>2012-10-11 19:53:52 +0200
commit6eb48f9602c3a21c85a38651c2e0b887e06b8d18 (patch)
tree641403b5a61dcc12d3419c0028a786ffc21cafff /src/reflect/scala/reflect/runtime/package.scala
parent553ee0118dbc052bed8c4580376b48cd9cb5d0f9 (diff)
downloadscala-6eb48f9602c3a21c85a38651c2e0b887e06b8d18.tar.gz
scala-6eb48f9602c3a21c85a38651c2e0b887e06b8d18.tar.bz2
scala-6eb48f9602c3a21c85a38651c2e0b887e06b8d18.zip
docs for reflection and macros
Diffstat (limited to 'src/reflect/scala/reflect/runtime/package.scala')
-rw-r--r--src/reflect/scala/reflect/runtime/package.scala11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/reflect/scala/reflect/runtime/package.scala b/src/reflect/scala/reflect/runtime/package.scala
index 278629adb6..b3f9ba5817 100644
--- a/src/reflect/scala/reflect/runtime/package.scala
+++ b/src/reflect/scala/reflect/runtime/package.scala
@@ -1,10 +1,19 @@
package scala.reflect
+/** Entry points into runtime reflection.
+ * See [[scala.reflect.api.package the overview page]] for details on how to use them.
+ */
package object runtime {
- // type is api.JavaUniverse because we only want to expose the `scala.reflect.api.*` subset of reflection
+ /** The entry point into runtime reflection.
+ * See [[scala.reflect.api.package the overview page]] for details on how to use it.
+ */
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.
+ */
// implementation hardwired to the `currentMirror` method below
// using the mechanism implemented in `scala.tools.reflect.FastTrack`
def currentMirror: universe.Mirror = ??? // macro