diff options
| author | Heather Miller <heather.miller@epfl.ch> | 2011-09-17 20:24:26 +0000 |
|---|---|---|
| committer | Heather Miller <heather.miller@epfl.ch> | 2011-09-17 20:24:26 +0000 |
| commit | 7343e044153fb5f91028878fe1ddf341f62b37ee (patch) | |
| tree | 5e2c6a27794c7204ce5cf9ecfdcdd7fc99dd9ee4 /src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt | |
| parent | fef6649b31d58e2cc239518cb031d39e1ac58b70 (diff) | |
| download | scala-7343e044153fb5f91028878fe1ddf341f62b37ee.tar.gz scala-7343e044153fb5f91028878fe1ddf341f62b37ee.tar.bz2 scala-7343e044153fb5f91028878fe1ddf341f62b37ee.zip | |
Adds ability to document root package, as well ...
Adds ability to document root package, as well the first cut of an
introduction to the API. Contributed by Iain McGinniss during the
September doc spree.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt')
| -rw-r--r-- | src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt | 18 |
1 files changed, 18 insertions, 0 deletions
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..09be5da485 --- /dev/null +++ b/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt @@ -0,0 +1,18 @@ +This is the documentation for the Scala standard library. + +Parts of the standard library are imported by default into all Scala source files: the [[scala]] package, and +the contents of the [[scala.Predef]] object. In turn, these imports bring in parts of other packages throughout +the standard library. + +The standard library is composed of the following fundamental packages: + + - scala.[[scala.actors]] - A Erlang-style concurrency framework. + - scala.[[scala.collection]] - A powerful collections (data structures) framework with higher order functions for manipulation. Both [[scala.collection.mutable]] and [[scala.collection.immutable]] variants of most collection types exist, with the immutable collections being the default. Automatic parallelisation of manipulation operations is possible through the use of the [[scala.collection.parallel]] collection types. + - scala.[[scala.concurrent]] - Simplified execution of functions in separate threads. + - scala.[[scala.io]] - IO abstractions. + - scala.[[scala.math]] - Arbitrary precision numeric types and basic math functions. + - scala.[[scala.swing]] - UI toolkit, provides scala abstractions around the Java Swing toolkit. + - scala.[[scala.sys]] - Interaction with other processes and the operating system. + - scala.util.[[scala.util.matching]] - Text pattern matching using regular expressions. + - scala.util.[[scala.util.parsing]] - Framework for constructing parse trees. Includes a parser combinator library. + - scala.[[scala.xml]] - XML parsing, DOM manipulation and serialization. |