This is the home page of an effort to complete the Scala API documentation. We need your help!

A fully documented feature should cover:

• Overview
• Description of each parameter and return value
• Any side-effects
• Any preconditions
• Any special treatment of nulls, especially if the method may return null
• Time/space complexity guarantees
• Exceptions that may be thrown
• Idiomatic usage example, if this is non-obvious
• Related features

The documentation is hosted in a Mercurial repository which is based on a mirror of the official Subversion tree (~270MB download unfortunately since it contains the complete history of Scala). Anyone can gain commit access to this repository (see below). The results of this effort will then be submitted back to EPFL at regular intervals.

There’s a brief overview of Mercurial and Scalaforge here, and to get this particular repo, use:

hg clone http://hg.scalaforge.org/scala/docs/

Below is the library source tree as of 2008-02-09. To avoid duplication of effort, please annotate each file (or group of files) as “In progress” and “Done” as appropriate, and sign and date.

scala
|-- Annotation.scala
|-- Application.scala
|-- Array.scala
|-- Attribute.scala
|-- BigDecimal.scala
|-- BigInt.scala
|-- BufferedIterator.scala
|-- ByNameFunction.scala
|-- Cell.scala
|-- ClassfileAnnotation.scala
|-- ClassfileAttribute.scala
|-- Collection.scala
|-- CollectionProxy.scala
|-- Console.scala
|-- CountedIterator.scala
|-- Enumeration.scala
|-- Function.scala
|-- Function0.scala
|-- Function1.scala
|-- Function2.scala
|-- Function3.scala
|-- Function4.scala
|-- Function5.scala
|-- Function6.scala
|-- Function7.scala
|-- Function8.scala
|-- Function9.scala
|-- Iterable.scala
|-- IterableProxy.scala
|-- Iterator.scala
|-- List.scala
|-- MatchError.scala
|-- Math.scala
|-- NotDefinedError.scala
|-- NotNull.scala
|-- Option.scala
|-- Ordered.scala
|-- PartialFunction.scala
|-- PartiallyOrdered.scala
|-- Predef.scala
|-- Product.scala
|-- Product1.scala
|-- Product10.scala
|-- Product11.scala
|-- Product12.scala
|-- Product13.scala
|-- Product14.scala
|-- Product15.scala
|-- Product16.scala
|-- Product17.scala
|-- Product18.scala
|-- Product19.scala
|-- Product2.scala
|-- Product20.scala
|-- Product21.scala
|-- Product22.scala
|-- Product3.scala
|-- Product4.scala
|-- Product5.scala
|-- Product6.scala
|-- Product7.scala
|-- Product8.scala
|-- Product9.scala
|-- Proxy.scala
|-- Random.scala
|-- RandomAccessSeq.scala
|-- Range.scala
|-- Responder.scala
|-- ScalaObject.scala
|-- Seq.scala
|-- SeqProxy.scala
|-- SerialVersionUID.scala
|-- StaticAnnotation.scala
|-- StaticAttribute.scala
|-- Stream.scala
|-- StringBuilder.scala
|-- Symbol.scala
|-- Tuple1.scala
|-- Tuple10.scala
|-- Tuple11.scala
|-- Tuple12.scala
|-- Tuple13.scala
|-- Tuple14.scala
|-- Tuple15.scala
|-- Tuple16.scala
|-- Tuple17.scala
|-- Tuple18.scala
|-- Tuple19.scala
|-- Tuple2.scala
|-- Tuple20.scala
|-- Tuple21.scala
|-- Tuple22.scala
|-- Tuple3.scala
|-- Tuple4.scala
|-- Tuple5.scala
|-- Tuple6.scala
|-- Tuple7.scala
|-- Tuple8.scala
|-- Tuple9.scala
|-- TypeConstraint.scala
|-- UninitializedError.scala
|-- cloneable.scala
|-- collection
|   |-- BitSet.scala
|   |-- Map.scala
|   |-- MapProxy.scala
|   |-- Ranged.scala
|   |-- RollbackIterator.scala
|   |-- Set.scala
|   |-- SetProxy.scala
|   |-- Sorted.scala
|   |-- SortedMap.scala
|   |-- SortedSet.scala
|   |-- immutable
|   |   |-- BitSet.scala
|   |   |-- EmptyMap.scala
|   |   |-- EmptySet.scala
|   |   |-- HashMap.scala
|   |   |-- HashSet.scala
|   |   |-- ImmutableIterator.scala
|   |   |-- ListMap.scala
|   |   |-- ListSet.scala
|   |   |-- Map.scala
|   |   |-- Map1.scala
|   |   |-- Map2.scala
|   |   |-- Map3.scala
|   |   |-- Map4.scala
|   |   |-- Queue.scala
|   |   |-- RedBlack.scala
|   |   |-- Set.scala
|   |   |-- Set1.scala
|   |   |-- Set2.scala
|   |   |-- Set3.scala
|   |   |-- Set4.scala
|   |   |-- SortedMap.scala
|   |   |-- SortedSet.scala
|   |   |-- Stack.scala
|   |   |-- Tree.scala
|   |   |-- TreeMap.scala
|   |   |-- TreeMap.scala.disabled
|   |   |-- TreeSet.scala
|   |   `-- UnbalancedTreeMap.scala
|   |-- jcl
|   |   |-- ArrayList.scala
|   |   |-- Buffer.scala
|   |   |-- BufferIterator.scala
|   |   |-- BufferWrapper.scala
|   |   |-- Collection.scala
|   |   |-- CollectionWrapper.scala
|   |   |-- HashMap.scala
|   |   |-- HashSet.scala
|   |   |-- IdentityHashMap.scala
|   |   |-- IterableWrapper.scala
|   |   |-- LinkedHashMap.scala
|   |   |-- LinkedHashSet.scala
|   |   |-- LinkedList.scala
|   |   |-- Map.scala
|   |   |-- MapWrapper.scala
|   |   |-- MutableIterable.scala
|   |   |-- MutableIterator.scala
|   |   |-- MutableSeq.scala
|   |   |-- Ranged.scala
|   |   |-- SeqIterator.scala
|   |   |-- Set.scala
|   |   |-- SetWrapper.scala
|   |   |-- Sorted.scala
|   |   |-- SortedMap.scala
|   |   |-- SortedMapWrapper.scala
|   |   |-- SortedSet.scala
|   |   |-- SortedSetWrapper.scala
|   |   |-- Tests.scala
|   |   |-- TreeMap.scala
|   |   |-- TreeSet.scala
|   |   `-- WeakHashMap.scala
|   `-- mutable
|       |-- ArrayBuffer.scala
|       |-- BitSet.scala
|       |-- Buffer.scala
|       |-- BufferProxy.scala
|       |-- CloneableCollection.scala
|       |-- DefaultEntry.scala
|       |-- DefaultMapModel.scala
|       |-- DoubleLinkedList.scala
|       |-- FlatHashTable.scala  (In Progress: Gordon Miller, 2008Mar12)
|       |-- HashMap.scala
|       |-- HashSet.scala
|       |-- HashTable.scala
|       |-- History.scala
|       |-- ImmutableMapAdaptor.scala
|       |-- ImmutableSetAdaptor.scala
|       |-- JavaMapAdaptor.scala
|       |-- JavaSetAdaptor.scala
|       |-- LinkedHashSet.scala
|       |-- LinkedList.scala
|       |-- ListBuffer.scala
|       |-- Location.scala
|       |-- Map.scala
|       |-- MapProxy.scala
|       |-- Message.scala
|       |-- MultiMap.scala
|       |-- MutableList.scala
|       |-- ObservableBuffer.scala
|       |-- ObservableMap.scala
|       |-- ObservableSet.scala
|       |-- PriorityQueue.scala
|       |-- PriorityQueueProxy.scala
|       |-- Publisher.scala
|       |-- Queue.scala
|       |-- QueueProxy.scala
|       |-- ResizableArray.scala
|       |-- RevertableHistory.scala
|       |-- Scriptable.scala
|       |-- Set.scala
|       |-- SetProxy.scala
|       |-- SingleLinkedList.scala
|       |-- Stack.scala
|       |-- StackProxy.scala
|       |-- Subscriber.scala
|       |-- SynchronizedBuffer.scala
|       |-- SynchronizedMap.scala
|       |-- SynchronizedPriorityQueue.scala
|       |-- SynchronizedQueue.scala
|       |-- SynchronizedSet.scala
|       |-- SynchronizedStack.scala
|       `-- Undoable.scala
|-- compat
|   `-- Platform.scala
|-- concurrent
|   |-- Channel.scala
|   |-- Lock.scala
|   |-- MailBox.scala
|   |-- SyncChannel.scala
|   |-- SyncVar.scala
|   |-- TIMEOUT.scala
|   |-- jolib.scala
|   |-- ops.scala
|   `-- pilib.scala
|-- deprecated.scala
|-- inline.scala
|-- io
|   |-- BufferedSource.scala
|   |-- BytePickle.scala
|   |-- Position.scala
|   |-- Source.scala
|   `-- UTF8Codec.scala
|-- mobile
|   |-- Code.scala
|   `-- Location.scala
|-- native.scala
|-- noinline.scala
|-- ref
|   |-- PhantomReference.scala
|   |-- Reference.scala
|   |-- ReferenceQueue.scala
|   |-- ReferenceWrapper.scala
|   |-- SoftReference.scala
|   `-- WeakReference.scala
|-- reflect
|   |-- BeanDescription.scala
|   |-- BeanDisplayName.scala
|   |-- BeanInfo.scala
|   |-- BeanInfoSkip.scala
|   |-- BeanProperty.scala
|   |-- Code.scala
|   |-- Print.scala
|   |-- ScalaBeanInfo.scala
|   |-- Symbol.scala
|   |-- Tree.scala
|   |-- Type.scala
|   `-- TypedCode.scala
|-- remote.scala
|-- runtime
|   |-- BooleanRef.java
|   |-- BoxedAnyArray.scala
|   |-- BoxedArray.scala
|   |-- BoxedBooleanArray.scala
|   |-- BoxedByteArray.scala
|   |-- BoxedCharArray.scala
|   |-- BoxedDoubleArray.scala
|   |-- BoxedFloatArray.scala
|   |-- BoxedIntArray.scala
|   |-- BoxedLongArray.scala
|   |-- BoxedObjectArray.scala
|   |-- BoxedShortArray.scala
|   |-- BoxedUnit.java
|   |-- BoxesRunTime.java
|   |-- ByteRef.java
|   |-- CharRef.java
|   |-- DoubleRef.java
|   |-- ExceptionHandling.java
|   |-- FloatRef.java
|   |-- IntRef.java
|   |-- LongRef.java
|   |-- NonLocalReturnException.scala
|   |-- Nothing$.scala
|   |-- Null$.scala
|   |-- ObjectRef.java
|   |-- RichBoolean.scala
|   |-- RichByte.scala
|   |-- RichChar.scala
|   |-- RichDouble.scala
|   |-- RichException.scala
|   |-- RichFloat.scala
|   |-- RichInt.scala
|   |-- RichLong.scala
|   |-- RichShort.scala
|   |-- RichString.scala
|   |-- RichStringBuilder.scala
|   |-- ScalaRunTime.scala
|   |-- ShortRef.java
|   `-- StringAdd.scala
|-- serializable.scala
|-- testing
|   |-- Benchmark.scala (In Progress: Gordon Miller, 2008Mar12)
|   `-- SUnit.scala  (Done: Gordon Miller, 2008Mar19)
|-- text
|   `-- Document.scala
|-- throws.scala
|-- transient.scala
|-- unchecked.scala
|-- unsealed.scala
|-- util
|   |-- DynamicVariable.scala
|   |-- Fluid.scala
|   |-- Properties.scala
|   |-- Sorting.scala
|   |-- automata
|   |   |-- BaseBerrySethi.scala
|   |   |-- DetWordAutom.scala
|   |   |-- Inclusion.scala
|   |   |-- NondetWordAutom.scala
|   |   |-- SubsetConstruction.scala
|   |   `-- WordBerrySethi.scala
|   |-- grammar
|   |   |-- HedgeRHS.scala
|   |   `-- TreeRHS.scala
|   |-- logging
|   |   |-- ConsoleLogger.scala
|   |   `-- Logged.scala
|   |-- parsing
|   |   |-- CharInputStreamIterator.scala
|   |   |-- Parsers.scala
|   |   |-- SimpleTokenizer.scala
|   |   |-- ast
|   |   |   |-- AbstractSyntax.scala
|   |   |   `-- Binders.scala
|   |   |-- combinator
|   |   |   |-- ImplicitConversions.scala
|   |   |   |-- Parsers.scala
|   |   |   |-- lexical
|   |   |   |   |-- Lexical.scala
|   |   |   |   |-- Scanners.scala
|   |   |   |   `-- StdLexical.scala
|   |   |   |-- syntactical
|   |   |   |   |-- StandardTokenParsers.scala
|   |   |   |   |-- StdTokenParsers.scala
|   |   |   |   `-- TokenParsers.scala
|   |   |   `-- testing
|   |   |       `-- Tester.scala
|   |   |-- combinatorold
|   |   |   |-- $tilde.scala
|   |   |   |-- ImplicitConversions.scala
|   |   |   |-- Parsers.scala
|   |   |   |-- lexical
|   |   |   |   |-- Lexical.scala
|   |   |   |   |-- Scanners.scala
|   |   |   |   `-- StdLexical.scala
|   |   |   |-- syntactical
|   |   |   |   |-- BindingParsers.scala
|   |   |   |   |-- StdTokenParsers.scala
|   |   |   |   `-- TokenParsers.scala
|   |   |   `-- testing
|   |   |       `-- Tester.scala
|   |   |-- input
|   |   |   |-- CharArrayPosition.scala
|   |   |   |-- CharArrayReader.scala
|   |   |   |-- NoPosition.scala
|   |   |   |-- Position.scala
|   |   |   |-- Positional.scala
|   |   |   |-- Reader.scala
|   |   |   `-- StreamReader.scala
|   |   |-- json
|   |   |   |-- JSON.scala (In progress: Derek Chen-Becker. This will actually be directly on the Scala repo)
|   |   |   |-- Lexer.scala (In progress: Derek Chen-Becker. This will actually be directly on the Scala repo)
|   |   |   `-- Parser.scala (In progress: Derek Chen-Becker. This will actually be directly on the Scala repo)
|   |   `-- syntax
|   |       |-- StdTokens.scala
|   |       `-- Tokens.scala
|   `-- regexp
|       |-- Base.scala
|       |-- PointedHedgeExp.scala
|       |-- SyntaxError.scala
|       `-- WordExp.scala
|-- volatile.scala
`-- xml
    |-- Atom.scala
    |-- Comment.scala
    |-- Document.scala
    |-- Elem.scala
    |-- EntityRef.scala
    |-- Group.scala
    |-- HasKeyValue.scala
    |-- MalformedAttributeException.scala
    |-- MetaData.scala
    |-- NamespaceBinding.scala
    |-- Node.scala
    |-- NodeBuffer.scala
    |-- NodeSeq.scala
    |-- NodeTraverser.scala
    |-- Null.scala
    |-- Parsing.scala
    |-- PrefixedAttribute.scala
    |-- PrettyPrinter.scala
    |-- ProcInstr.scala
    |-- QNode.scala
    |-- SpecialNode.scala
    |-- Text.scala
    |-- TextBuffer.scala
    |-- TopScope.scala
    |-- TypeSymbol.scala
    |-- Unparsed.scala
    |-- UnprefixedAttribute.scala
    |-- Utility.scala
    |-- XML.scala
    |-- dtd
    |   |-- ContentModel.scala
    |   |-- ContentModelParser.scala
    |   |-- DTD.scala
    |   |-- Decl.scala
    |   |-- DocType.scala
    |   |-- DtdTypeSymbol.scala
    |   |-- ElementValidator.scala
    |   |-- ExternalID.scala
    |   |-- Scanner.scala
    |   |-- Tokens.scala
    |   `-- ValidationException.scala
    |-- factory
    |   |-- Binder.scala
    |   |-- LoggedNodeFactory.scala
    |   `-- NodeFactory.scala
    |-- include
    |   |-- CircularIncludeException.scala
    |   |-- UnavailableResourceException.scala
    |   |-- XIncludeException.scala
    |   `-- sax
    |       |-- EncodingHeuristics.scala
    |       |-- Main.scala
    |       |-- XIncludeFilter.scala
    |       `-- XIncluder.scala
    |-- parsing
    |   |-- ConstructingHandler.scala
    |   |-- ConstructingParser.scala
    |   |-- DefaultMarkupHandler.scala
    |   |-- ExternalSources.scala
    |   |-- FactoryAdapter.scala
    |   |-- FatalError.scala
    |   |-- MarkupHandler.scala
    |   |-- MarkupParser.scala
    |   |-- NoBindingFactoryAdapter.scala
    |   |-- TokenTests.scala
    |   `-- ValidatingMarkupHandler.scala
    |-- path
    |   `-- Expression.scala
    |-- persistent
    |   |-- CachedFileStorage.scala
    |   |-- Index.scala
    |   |-- IndexedStorage.scala
    |   `-- SetStorage.scala
    |-- pull
    |   |-- XMLEvent.scala
    |   `-- XMLEventReader.scala
    `-- transform
        |-- BasicTransformer.scala
        |-- RewriteRule.scala
        `-- RuleTransformer.scala