summaryrefslogtreecommitdiff
path: root/src/library/rootdoc.txt
diff options
context:
space:
mode:
authorAleksandar Prokopec <axel22@gmail.com>2012-02-16 13:34:06 +0100
committerAleksandar Prokopec <axel22@gmail.com>2012-02-16 13:34:06 +0100
commit53b05bb12f5a7a50448bcac9434389bf95273c45 (patch)
treed10140f4a3f2ea46dd39b47828c1326e9a61681e /src/library/rootdoc.txt
parentf2ccb43a844e484ae511c8cff3fbf534a0d86ebe (diff)
parent91148376049a152edec12348ff9b7e9e93e6ebe1 (diff)
downloadscala-53b05bb12f5a7a50448bcac9434389bf95273c45.tar.gz
scala-53b05bb12f5a7a50448bcac9434389bf95273c45.tar.bz2
scala-53b05bb12f5a7a50448bcac9434389bf95273c45.zip
Merge branch 'master' into execution-context
Conflicts: src/library/scala/package.scala
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.