summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorEugene Burmako <xeno.by@gmail.com>2012-09-25 17:48:50 +0200
committerEugene Burmako <xeno.by@gmail.com>2012-09-27 15:48:58 +0200
commit3f30db36d115a1f7b86153fa5009d8c8c4309f36 (patch)
tree103df88f0dd12d73672707e669b625c9772738d6 /src
parent4039eb06828986f67a309097df03a414c35aed4e (diff)
downloadscala-3f30db36d115a1f7b86153fa5009d8c8c4309f36.tar.gz
scala-3f30db36d115a1f7b86153fa5009d8c8c4309f36.tar.bz2
scala-3f30db36d115a1f7b86153fa5009d8c8c4309f36.zip
no longer docs scala.reflect.io
The only place we use something from scala.reflect.io in the public API is Symbol.associatedFile, so I've excluded scala.reflect.io from scaladoc and added a "warning: experimental" comment to associatedFile instead. I'd argue that this greatly simplifies the surface of reflection API (typing scala.reflect in the search bar now yields 3 packages instead of 4).
Diffstat (limited to 'src')
-rw-r--r--src/reflect/scala/reflect/api/Symbols.scala4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/reflect/scala/reflect/api/Symbols.scala b/src/reflect/scala/reflect/api/Symbols.scala
index d8f955ddf3..637ac229b8 100644
--- a/src/reflect/scala/reflect/api/Symbols.scala
+++ b/src/reflect/scala/reflect/api/Symbols.scala
@@ -209,6 +209,10 @@ trait Symbols { self: Universe =>
/** Source file if this symbol is created during this compilation run,
* or a class file if this symbol is loaded from a *.class or *.jar.
+ *
+ * The return type is [[scala.reflect.io.AbstractFile]], which belongs to an experimental part of Scala reflection.
+ * It should not be used unless you know what you are doing. In subsequent releases, this API will be refined
+ * and exposed as a part of scala.reflect.api.
*/
def associatedFile: scala.reflect.io.AbstractFile