summaryrefslogtreecommitdiff
path: root/src/library/rootdoc.txt
diff options
context:
space:
mode:
authorVlad Ureche <vlad.ureche@gmail.com>2012-02-05 19:32:52 +0100
committerPaul Phillips <paulp@improving.org>2012-02-06 15:29:43 -0800
commit0ccd295a785c35ebafe51771160bd851a9f622fe (patch)
treecc14d7c112f9aa2bc6dfc4b001ec4e8896b2af08 /src/library/rootdoc.txt
parent7ee4c018cefcf08f9c8812227c9a861614a30d9f (diff)
downloadscala-0ccd295a785c35ebafe51771160bd851a9f622fe.tar.gz
scala-0ccd295a785c35ebafe51771160bd851a9f622fe.tar.bz2
scala-0ccd295a785c35ebafe51771160bd851a9f622fe.zip
Added a rootdoc page for the compiler API scaladoc
Diffstat (limited to 'src/library/rootdoc.txt')
-rw-r--r--src/library/rootdoc.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/library/rootdoc.txt b/src/library/rootdoc.txt
new file mode 100644
index 0000000000..6145429f1e
--- /dev/null
+++ b/src/library/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.