summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGilles Dubochet <gilles.dubochet@epfl.ch>2008-04-18 15:59:23 +0000
committerGilles Dubochet <gilles.dubochet@epfl.ch>2008-04-18 15:59:23 +0000
commit6b6afed0122812ebfed61a5f626e36b3091d6a93 (patch)
tree63e927bca22c64a514d80b0a97f927392076e0e8
parent1dbb53f9b698dbed940964550fb33930d80794c8 (diff)
downloadscala-6b6afed0122812ebfed61a5f626e36b3091d6a93.tar.gz
scala-6b6afed0122812ebfed61a5f626e36b3091d6a93.tar.bz2
scala-6b6afed0122812ebfed61a5f626e36b3091d6a93.zip
(1) API docs for private classes and DBC are no...
(1) API docs for private classes and DBC are no longer generated. Private classes are needed by the compiler but shouldn't be used by clients. DBC is in cold storage (available but not recommended) until DBC2 is ready. (2) Removed "reflect.TypedCode" that is obsolete.
-rw-r--r--sabbus.xml15
-rw-r--r--src/library/scala/reflect/Code.scala2
-rw-r--r--src/library/scala/reflect/Manifest.scala13
-rw-r--r--src/library/scala/reflect/Print.scala1
-rw-r--r--src/library/scala/reflect/Symbol.scala13
-rw-r--r--src/library/scala/reflect/Tree.scala19
-rw-r--r--src/library/scala/reflect/Type.scala32
-rw-r--r--src/library/scala/reflect/TypedCode.scala15
8 files changed, 76 insertions, 34 deletions
diff --git a/sabbus.xml b/sabbus.xml
index 2892f4360a..a4631ade3f 100644
--- a/sabbus.xml
+++ b/sabbus.xml
@@ -769,11 +769,22 @@ DOCUMENTATION
doctitle="Scala ${version.number} API"
classpathref="pack.classpath">
<src>
- <files includes="${src.dir}/dbc"/>
<files includes="${src.dir}/actors"/>
- <files includes="${src.dir}/library"/>
+ <files includes="${src.dir}/library/scala"/>
</src>
<include name="**/*.scala"/>
+ <exclude name="reflect/Code.scala"/>
+ <exclude name="reflect/Manifest.scala"/>
+ <exclude name="reflect/Print.scala"/>
+ <exclude name="reflect/Symbol.scala"/>
+ <exclude name="reflect/Tree.scala"/>
+ <exclude name="reflect/Type.scala"/>
+ <exclude name="reflect/TypedCode.scala"/>
+ <exclude name="runtime/*Array.scala"/>
+ <exclude name="runtime/*$.scala"/>
+ <exclude name="runtime/ScalaRunTime.scala"/>
+ <exclude name="runtime/StreamCons.scala"/>
+ <exclude name="runtime/StringAdd.scala"/>
</scaladoc>
<touch file="${build-docs.dir}/library.complete" verbose="no"/>
<stopwatch name="docs.lib.timer" action="total"/>
diff --git a/src/library/scala/reflect/Code.scala b/src/library/scala/reflect/Code.scala
index ddf785a8b2..d2b0429cec 100644
--- a/src/library/scala/reflect/Code.scala
+++ b/src/library/scala/reflect/Code.scala
@@ -13,8 +13,10 @@ package scala.reflect
import Predef.Error
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
class Code[Type](val tree: Tree)
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
object Code {
def lift[A](tree: A): Code[A] =
throw new Error("Code was not lifted by compiler")
diff --git a/src/library/scala/reflect/Manifest.scala b/src/library/scala/reflect/Manifest.scala
index c44ea512ec..14329e9526 100644
--- a/src/library/scala/reflect/Manifest.scala
+++ b/src/library/scala/reflect/Manifest.scala
@@ -8,10 +8,11 @@
package scala.reflect
-/** A Manifest[T] is a descriptor for the type T.
- * The object `Manifest' defines factory methods for manifests which still need to be implemented.
- * Also still to be done are manifests for refinement types.
- */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * A Manifest[T] is a descriptor for the type T.
+ * The object `Manifest' defines factory methods for manifests which still need to be implemented.
+ * Also still to be done are manifests for refinement types.
+ */
object Manifest {
/** Manifest for the singleton type `value.type'
@@ -49,7 +50,7 @@ object Manifest {
def intersectionType[T](parents: Manifest[_]*): Manifest[T] = null
}
-/** A Manifest[T] is a descriptor for the type T.
- */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * A Manifest[T] is a descriptor for the type T. */
abstract class Manifest[T]
diff --git a/src/library/scala/reflect/Print.scala b/src/library/scala/reflect/Print.scala
index 039160077c..eba332c39a 100644
--- a/src/library/scala/reflect/Print.scala
+++ b/src/library/scala/reflect/Print.scala
@@ -11,6 +11,7 @@
package scala.reflect
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
object Print extends Function1[Any, String] {
def apply(any: Any): String = any match {
diff --git a/src/library/scala/reflect/Symbol.scala b/src/library/scala/reflect/Symbol.scala
index e4db7e3641..bd559dd980 100644
--- a/src/library/scala/reflect/Symbol.scala
+++ b/src/library/scala/reflect/Symbol.scala
@@ -13,12 +13,14 @@ package scala.reflect
import Predef._
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
abstract class Symbol {
val owner: Symbol
val name: String
val tpe: Type
}
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
abstract class GlobalSymbol(val fullname: String) extends Symbol {
private val pointIndex = fullname.lastIndexOf(".")
val owner: Symbol =
@@ -29,34 +31,43 @@ abstract class GlobalSymbol(val fullname: String) extends Symbol {
else fullname.substring(pointIndex+1, fullname.length())
}
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
abstract class LocalSymbol extends Symbol
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Class(override val fullname: String) extends GlobalSymbol(fullname) {
val tpe = NamedType(fullname)
}
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Method(override val fullname: String, tpe: Type) extends GlobalSymbol(fullname)
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Field(override val fullname: String, tpe: Type) extends GlobalSymbol(fullname)
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class TypeField(override val fullname: String, tpe: Type) extends GlobalSymbol(fullname)
-case class LocalValue(owner: Symbol, name: String, tpe: Type) extends LocalSymbol
+/** This type is required by the compiler and <b>should not be used in client code</b>. */case class LocalValue(owner: Symbol, name: String, tpe: Type) extends LocalSymbol
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class LocalMethod(owner: Symbol, name: String, tpe: Type) extends LocalSymbol
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case object NoSymbol extends Symbol {
val owner = null
val name = null
val tpe = NoType
}
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case object RootSymbol extends Symbol {
val owner = NoSymbol
val name = "<root>"
val tpe = NoPrefix
}
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class LabelSymbol(val name: String) extends Symbol {
val owner = NoSymbol
val tpe = NamedType("scala.Unit")
diff --git a/src/library/scala/reflect/Tree.scala b/src/library/scala/reflect/Tree.scala
index 5c07a71eb9..31a1bcaa3f 100644
--- a/src/library/scala/reflect/Tree.scala
+++ b/src/library/scala/reflect/Tree.scala
@@ -11,25 +11,44 @@
package scala.reflect
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
abstract class Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Ident(sym: Symbol) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Select(qual: Tree, sym: Symbol) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Literal(value: Any) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Apply(fun: Tree, args: List[Tree]) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class TypeApply(fun: Tree, args: List[Type]) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Function(params: List[Symbol], body: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class This(sym: Symbol) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Block(stats: List[Tree], expr: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class New(sym: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class If(condition: Tree, trueCase: Tree, falseCase: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Assign(destination: Tree, source: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Target(sym: LabelSymbol, body: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Goto(target: LabelSymbol) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class ValDef(sym: Symbol, rhs: Tree) extends Tree
//Monomorphic
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class ClassDef(sym: Symbol, tpe: Type, impl: Template) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class DefDef(sym: Symbol, vparamss: List[List[Tree]], ret: Type, rhs: Tree) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Super(psym: Symbol) extends Tree
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class Template(parents: List[Type], body: List[Tree]) extends Tree
diff --git a/src/library/scala/reflect/Type.scala b/src/library/scala/reflect/Type.scala
index 02e98e2fc9..627e5ddba7 100644
--- a/src/library/scala/reflect/Type.scala
+++ b/src/library/scala/reflect/Type.scala
@@ -13,37 +13,49 @@ package scala.reflect
import Predef._
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
abstract class Type
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case object NoPrefix extends Type
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case object NoType extends Type
-/** fullname */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * fullname */
case class NamedType(fullname: String) extends Type
-/** pre # sym */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * pre # sym */
case class PrefixedType(pre: Type, sym: Symbol) extends Type
-/** pre.type # sym == pre.sym */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * pre.type # sym == pre.sym */
case class SingleType(pre: Type, sym: Symbol) extends Type
-/** clazz.this */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * clazz.this */
case class ThisType(clazz: Symbol) extends Type
-/** clazz.super[superClazz] */
-/** <code>tpe[args1, ..., argsn]</code> */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * clazz.super[superClazz]
+ * <code>tpe[args1, ..., argsn]</code> */
case class AppliedType(tpe: Type, args: List[Type]) extends Type
-/** [a &lt;: lo &gt;: hi] */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * [a &lt;: lo &gt;: hi] */
case class TypeBounds(lo: Type, hi: Type) extends Type
-/** <code>(formals1 ... formalsn) restpe</code> */
+/** This type is required by the compiler and <b>should not be used in client code</b>.
+ * <code>(formals1 ... formalsn) restpe</code> */
case class MethodType(formals: List[Type], restpe: Type) extends Type
-/** */
+
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
case class PolyType(typeParams: List[Symbol], typeBounds: List[(Type, Type)], resultType: Type) extends Type
-/** */
+
+/** This type is required by the compiler and <b>should not be used in client code</b>. */
class ImplicitMethodType(formals: List[Type], restpe: Type)
extends MethodType(formals, restpe)
diff --git a/src/library/scala/reflect/TypedCode.scala b/src/library/scala/reflect/TypedCode.scala
deleted file mode 100644
index aff53ca7a1..0000000000
--- a/src/library/scala/reflect/TypedCode.scala
+++ /dev/null
@@ -1,15 +0,0 @@
-/* __ *\
-** ________ ___ / / ___ Scala API **
-** / __/ __// _ | / / / _ | (c) 2002-2007, LAMP/EPFL **
-** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
-** /____/\___/_/ |_/____/_/ | | **
-** |/ **
-\* */
-
-// $Id$
-
-
-package scala.reflect
-
-// This file is OBSOLETE, delete when build bootstraps without it
-class TypedCode[T](val code: Any)