summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorVlad Ureche <vlad.ureche@gmail.com>2012-10-10 22:12:23 +0200
committerEugene Burmako <xeno.by@gmail.com>2012-10-11 20:08:16 +0200
commite49ece4fb1c9e7b83624bc96c1d54078ef62c2bc (patch)
tree99221ded11585da94f86cb796cf945976bcc5d54 /src
parent706091cadbfd3d3d89df4acc68ea910679005ec8 (diff)
downloadscala-e49ece4fb1c9e7b83624bc96c1d54078ef62c2bc.tar.gz
scala-e49ece4fb1c9e7b83624bc96c1d54078ef62c2bc.tar.bz2
scala-e49ece4fb1c9e7b83624bc96c1d54078ef62c2bc.zip
Diagram tweaking
blocked by SI-6511
Diffstat (limited to 'src')
-rw-r--r--src/reflect/scala/reflect/api/Annotations.scala2
-rw-r--r--src/reflect/scala/reflect/api/Constants.scala2
-rw-r--r--src/reflect/scala/reflect/api/JavaUniverse.scala2
-rw-r--r--src/reflect/scala/reflect/api/Mirrors.scala2
-rw-r--r--src/reflect/scala/reflect/api/Names.scala5
-rw-r--r--src/reflect/scala/reflect/api/Position.scala2
-rw-r--r--src/reflect/scala/reflect/api/Positions.scala2
-rw-r--r--src/reflect/scala/reflect/api/Symbols.scala4
-rw-r--r--src/reflect/scala/reflect/api/TagInterop.scala5
-rw-r--r--src/reflect/scala/reflect/api/Trees.scala2
-rw-r--r--src/reflect/scala/reflect/api/Types.scala2
-rw-r--r--src/reflect/scala/reflect/api/Universe.scala2
-rw-r--r--src/reflect/scala/reflect/macros/Universe.scala4
13 files changed, 29 insertions, 7 deletions
diff --git a/src/reflect/scala/reflect/api/Annotations.scala b/src/reflect/scala/reflect/api/Annotations.scala
index a828b254fe..adba0eb8ad 100644
--- a/src/reflect/scala/reflect/api/Annotations.scala
+++ b/src/reflect/scala/reflect/api/Annotations.scala
@@ -23,6 +23,8 @@ import scala.collection.immutable.ListMap
* - literals (primitive and string constants),
* - arrays and
* - nested annotations.
+ *
+ * @contentDiagram
*/
trait Annotations { self: Universe =>
diff --git a/src/reflect/scala/reflect/api/Constants.scala b/src/reflect/scala/reflect/api/Constants.scala
index 8c532bd4dd..9e0573f0dc 100644
--- a/src/reflect/scala/reflect/api/Constants.scala
+++ b/src/reflect/scala/reflect/api/Constants.scala
@@ -10,6 +10,8 @@ package api
* This trait is the [[scala.reflect.api.Universe reflection API]] component that mirrors constant irreducible expressions
* such as `true`, `0` and `classOf[List]`. Constant values appear in the program abstract syntax tree and in annotation parameters
* wrapped in [[Constant `Constant`]] case classes.
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Constants {
self: Universe =>
diff --git a/src/reflect/scala/reflect/api/JavaUniverse.scala b/src/reflect/scala/reflect/api/JavaUniverse.scala
index 0283a75177..f83692034f 100644
--- a/src/reflect/scala/reflect/api/JavaUniverse.scala
+++ b/src/reflect/scala/reflect/api/JavaUniverse.scala
@@ -8,6 +8,8 @@ package api
*
* See the [[http://docs.scala-lang.org/overviews/reflection/overview.html Reflection Guide]] for details on how to use runtime reflection.
* @groupname JavaUniverse Java Mirrors
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait JavaUniverse extends Universe with JavaMirrors { self =>
diff --git a/src/reflect/scala/reflect/api/Mirrors.scala b/src/reflect/scala/reflect/api/Mirrors.scala
index bebc9488dd..32cfdf07fb 100644
--- a/src/reflect/scala/reflect/api/Mirrors.scala
+++ b/src/reflect/scala/reflect/api/Mirrors.scala
@@ -5,6 +5,8 @@ package api
*
* See the [[http://docs.scala-lang.org/overviews/reflection/overview.html Reflection Guide]] for a description of mirrors
* and infomation on getting started with Scala reflection API.
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Mirrors { self: Universe =>
diff --git a/src/reflect/scala/reflect/api/Names.scala b/src/reflect/scala/reflect/api/Names.scala
index 7b66906499..332c24e542 100644
--- a/src/reflect/scala/reflect/api/Names.scala
+++ b/src/reflect/scala/reflect/api/Names.scala
@@ -7,14 +7,15 @@ package api
* distinguish names of terms (like objects or members) and types. A term and a type of the
* same name can co-exist in an object.
*
- * @see [[http://docs.scala-lang.org/overviews/reflection/overview.html]].
-
* === Examples ===
*
* To search for the `map` method (which is a term) declared in the `List` class,
* use `typeOf[List[_]].member(newTermName("map"))`. To search for a type member, use
* newTypeName instead.
*
+ * @see [[http://docs.scala-lang.org/overviews/reflection/overview.html]].
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Names {
/** An implicit conversion from String to TermName.
diff --git a/src/reflect/scala/reflect/api/Position.scala b/src/reflect/scala/reflect/api/Position.scala
index d94df00875..3284caf155 100644
--- a/src/reflect/scala/reflect/api/Position.scala
+++ b/src/reflect/scala/reflect/api/Position.scala
@@ -26,7 +26,7 @@ trait Position extends Attachments {
/** Java file corresponding to the source file of this position.
*
- * The return type is [[scala.reflect.io.AbstractFile]], which belongs to an experimental part of Scala reflection.
+ * 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.
*
diff --git a/src/reflect/scala/reflect/api/Positions.scala b/src/reflect/scala/reflect/api/Positions.scala
index ec1cf21c75..8d8a0081cc 100644
--- a/src/reflect/scala/reflect/api/Positions.scala
+++ b/src/reflect/scala/reflect/api/Positions.scala
@@ -4,6 +4,8 @@ package api
/** This trait defines the concept of positions and operations on them.
*
* @see [[scala.reflect.api.Position]]
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Positions {
self: Universe =>
diff --git a/src/reflect/scala/reflect/api/Symbols.scala b/src/reflect/scala/reflect/api/Symbols.scala
index c69d2e1fc2..d59ca561a2 100644
--- a/src/reflect/scala/reflect/api/Symbols.scala
+++ b/src/reflect/scala/reflect/api/Symbols.scala
@@ -18,6 +18,8 @@ package api
* @define SYMACCESSORS Class [[Symbol]] defines `isXXX` test methods such as `isPublic` or `isFinal`, `params` and
* `returnType` methods for method symbols, `baseClasses` for class symbols and so on. Some of these methods don't
* make sense for certain subclasses of `Symbol` and return `NoSymbol`, `Nil` or other empty values.
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Symbols { self: Universe =>
@@ -330,7 +332,7 @@ 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.
+ * 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.
*
diff --git a/src/reflect/scala/reflect/api/TagInterop.scala b/src/reflect/scala/reflect/api/TagInterop.scala
index b495c3f50c..4e43f59706 100644
--- a/src/reflect/scala/reflect/api/TagInterop.scala
+++ b/src/reflect/scala/reflect/api/TagInterop.scala
@@ -2,6 +2,7 @@ package scala.reflect
package api
/** This trait provides type tag <-> manifest interoperability.
+ * @groupname TagInterop TypeTag and Manifest Interoperability
*/
trait TagInterop { self: Universe =>
// TODO `mirror` parameters are now of type `Any`, because I can't make these path-dependent types work
@@ -16,7 +17,7 @@ trait TagInterop { self: Universe =>
* {{{
* typeTagToManifest(scala.reflect.runtime.currentMirror, implicitly[TypeTag[String]])
* }}}
- * @group Tags
+ * @group TagInterop
*/
def typeTagToManifest[T: ClassTag](mirror: Any, tag: Universe#TypeTag[T]): Manifest[T] =
throw new UnsupportedOperationException("This universe does not support tag -> manifest conversions. Use a JavaUniverse, e.g. the scala.reflect.runtime.universe.")
@@ -30,7 +31,7 @@ trait TagInterop { self: Universe =>
* {{{
* manifestToTypeTag(scala.reflect.runtime.currentMirror, implicitly[Manifest[String]])
* }}}
- * @group Tags
+ * @group TagInterop
*/
def manifestToTypeTag[T](mirror: Any, manifest: Manifest[T]): Universe#TypeTag[T] =
throw new UnsupportedOperationException("This universe does not support manifest -> tag conversions. Use a JavaUniverse, e.g. the scala.reflect.runtime.universe.")
diff --git a/src/reflect/scala/reflect/api/Trees.scala b/src/reflect/scala/reflect/api/Trees.scala
index 1142bb042f..44f5776a57 100644
--- a/src/reflect/scala/reflect/api/Trees.scala
+++ b/src/reflect/scala/reflect/api/Trees.scala
@@ -32,6 +32,8 @@ package api
* @groupprio Factories 1
* @groupname Copying Tree Copying
* @groupprio Copying 1
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Trees { self: Universe =>
diff --git a/src/reflect/scala/reflect/api/Types.scala b/src/reflect/scala/reflect/api/Types.scala
index f4760cf088..2267f21609 100644
--- a/src/reflect/scala/reflect/api/Types.scala
+++ b/src/reflect/scala/reflect/api/Types.scala
@@ -64,6 +64,8 @@ package api
*
* @groupname TypeCreators Types - Creation
* @groupname TypeOps Types - Operations
+ *
+ * @contentDiagram hideNodes "*Api"
*/
trait Types { self: Universe =>
diff --git a/src/reflect/scala/reflect/api/Universe.scala b/src/reflect/scala/reflect/api/Universe.scala
index c047d1641e..d9be73fde9 100644
--- a/src/reflect/scala/reflect/api/Universe.scala
+++ b/src/reflect/scala/reflect/api/Universe.scala
@@ -71,6 +71,8 @@ package api
* `X`'s companion object, if it exists, is represented by a value `X` that is of type `XExtractor`.
* Moreover, for each type `X`, there is a value `XTag` of type `ClassTag[X]` that allows to pattern match on `X`.
* @groupprio Universe -1
+ *
+ * @contentDiagram hideNodes "*Api"
*/
abstract class Universe extends Symbols
with Types
diff --git a/src/reflect/scala/reflect/macros/Universe.scala b/src/reflect/scala/reflect/macros/Universe.scala
index 7c308fe4bf..86bc37b4c9 100644
--- a/src/reflect/scala/reflect/macros/Universe.scala
+++ b/src/reflect/scala/reflect/macros/Universe.scala
@@ -8,6 +8,8 @@ package macros
* such as `Symbol.deSkolemize` or `Tree.attachments`.
* @groupname Macros Macro Specific Additions
* @groupprio Macros -1
+ *
+ * @contentDiagram hideNodes "*Api"
*/
abstract class Universe extends scala.reflect.api.Universe {
@@ -224,7 +226,7 @@ abstract class Universe extends scala.reflect.api.Universe {
* Exposes information about the file as a part of a real or virtual file system
* along with the contents of that file.
*
- * The return type is [[scala.reflect.io.AbstractFile]], which belongs to an experimental part of Scala reflection.
+ * 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.
*/