diff options
author | Eugene Burmako <xeno.by@gmail.com> | 2012-09-25 17:48:50 +0200 |
---|---|---|
committer | Eugene Burmako <xeno.by@gmail.com> | 2012-09-27 15:48:58 +0200 |
commit | 3f30db36d115a1f7b86153fa5009d8c8c4309f36 (patch) | |
tree | 103df88f0dd12d73672707e669b625c9772738d6 | |
parent | 4039eb06828986f67a309097df03a414c35aed4e (diff) | |
download | scala-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).
-rw-r--r-- | build.xml | 2 | ||||
-rw-r--r-- | src/reflect/scala/reflect/api/Symbols.scala | 4 |
2 files changed, 5 insertions, 1 deletions
@@ -2336,7 +2336,7 @@ DOCUMENTATION docfooter="epfl" docsourceurl="${scaladoc.url}€{FILE_PATH}.scala#L1" docUncompilable="${src.dir}/library-aux" - skipPackages="scala.reflect.macros.internal:scala.reflect.internal:scala.reflect.runtime" + skipPackages="scala.reflect.macros.internal:scala.reflect.internal:scala.reflect.runtime:scala.reflect.io" sourcepath="${src.dir}" classpathref="pack.classpath" addparams="${scalac.args.all}" 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 |