summaryrefslogtreecommitdiff
path: root/src/compiler
diff options
context:
space:
mode:
authorPaul Phillips <paulp@improving.org>2012-02-05 22:39:08 -0800
committerPaul Phillips <paulp@improving.org>2012-02-05 22:39:08 -0800
commit28b2d0c13aba7156431076119c920c7dcee6dc77 (patch)
tree9dbafc7e785cb9e1bec309c3677f14df0f1633fc /src/compiler
parent5be13bf0e0a2df0ddeda7652db0f54c0cba6c3bf (diff)
downloadscala-28b2d0c13aba7156431076119c920c7dcee6dc77.tar.gz
scala-28b2d0c13aba7156431076119c920c7dcee6dc77.tar.bz2
scala-28b2d0c13aba7156431076119c920c7dcee6dc77.zip
Revert "Added a rootdoc page for the compiler API scaladoc"
This reverts commit e34098b7f6e37420198fa5c7c2820d0443b46cc4.
Diffstat (limited to 'src/compiler')
-rw-r--r--src/compiler/rootdoc.txt6
-rw-r--r--src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala4
-rw-r--r--src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt27
3 files changed, 30 insertions, 7 deletions
diff --git a/src/compiler/rootdoc.txt b/src/compiler/rootdoc.txt
deleted file mode 100644
index 173f604098..0000000000
--- a/src/compiler/rootdoc.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-The Scala compiler API.
-
-The following resources are useful for Scala plugin/compiler development:
- - [[http://www.scala-lang.org/node/215 Scala development tutorials]] on [[http://www.scala-lang.org www.scala-lang.org]]
- - [[https://wiki.scala-lang.org/display/SIW/ Scala Internals wiki]]
- - [[http://lampwww.epfl.ch/~magarcia/ScalaCompilerCornerReloaded/ Scala compiler corner]], maintained by Miguel
diff --git a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
index 4f05678d85..c21507ef45 100644
--- a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
+++ b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
@@ -80,7 +80,9 @@ class HtmlFactory(val universe: doc.Universe, index: doc.Index) {
"selected.png",
"selected2-right.png",
"selected2.png",
- "unselected.png"
+ "unselected.png",
+
+ "rootdoc.txt"
)
/** Generates the Scaladoc site for a model into the site root.
diff --git a/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt b/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt
new file mode 100644
index 0000000000..6145429f1e
--- /dev/null
+++ b/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt
@@ -0,0 +1,27 @@
+This is the documentation for the Scala standard library.
+
+== Package structure ==
+
+The [[scala]] package contains core types.
+
+scala.[[scala.collection]] and its subpackages contain a collections framework with higher-order functions for manipulation. Both [[scala.collection.immutable]] and [[scala.collection.mutable]] data structures are available, with immutable as the default. The [[scala.collection.parallel]] collections provide automatic parallel operation.
+
+Other important packages include:
+
+ - scala.[[scala.actors]] - Concurrency framework inspired by Erlang.
+ - scala.[[scala.io]] - Input and output.
+ - scala.[[scala.math]] - Basic math functions and additional numeric types.
+ - scala.[[scala.sys]] - Interaction with other processes and the operating system.
+ - scala.util.[[scala.util.matching]] - Pattern matching in text using regular expressions.
+ - scala.util.parsing.[[scala.util.parsing.combinator]] - Composable combinators for parsing.
+ - scala.[[scala.xml]] - XML parsing, manipulation, and serialization.
+
+Many other packages exist. See the complete list on the left.
+
+== Automatic imports ==
+
+Identifiers in the scala package and the [[scala.Predef]] object are always in scope by default.
+
+Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, List is an alias for scala.collection.immutable.[[scala.collection.immutable.List]].
+
+Other aliases refer to classes providing by the underlying platform. For example, on the JVM, String is an alias for java.lang.String.