Merged revisions 22108,22114,22121,22130-22131,...

Merged revisions
22108,22114,22121,22130-22131,22137,22140-22142,22147-22149,22167-22168,
22174,22176-22177,22182,22186,22188-22189,22194-22199,22211,22215,22234,
22248-22249,22260-22261,22276 via svnmerge from
https://lampsvn.epfl.ch/svn-repos/scala/scala/trunk

........
  r22108 | odersky | 2010-05-31 19:23:38 +0200 (Mon, 31 May 2010) | 1 line

  made hashset more robust for concurrent access to reduce eclipse race
conditions. ........ r22114 | prokopec | 2010-06-01 18:15:40 +0200 (Tue,
01 Jun 2010) | 1 line

  Fixes #3496. No review.
........
  r22121 | rytz | 2010-06-02 11:57:41 +0200 (Wed, 02 Jun 2010) | 1 line

  some tests. no review
........
  r22130 | dubochet | 2010-06-02 15:11:24 +0200 (Wed, 02 Jun 2010) | 1 line

  Removed unnecessary files containing code with an uncertain copyright
status. ........ r22131 | dubochet | 2010-06-02 15:41:19 +0200 (Wed, 02
Jun 2010) | 1 line

  Added mandatory copyright notices for some libraries shipped with
Scala. ........ r22137 | dubochet | 2010-06-02 16:04:52 +0200 (Wed, 02
Jun 2010) | 1 line

  Added more license notices for things shipped with Scala. ........
r22140 | dubochet | 2010-06-02 18:23:43 +0200 (Wed, 02 Jun 2010) | 1
line

  [scaladoc] Updated man page for Scaladoc 2.
........
  r22141 | prokopec | 2010-06-02 18:31:56 +0200 (Wed, 02 Jun 2010) | 4 lines

  Partially solves the problem for #3502. review by extempore

  This commit reimplements filter for Streams, but does not reimplement
map in StreamWithFilter.

  The problem is that GC can't collect instances of Streams residing on the stack if there are multiple references to the Stream (more than a single one on the stack on which a Stream method is invoked). In the case of a StreamWithFilter, being an inner class, there is always an `$outer` reference to the outer object, so there is little GC can do. Possible solution - change the return type of WithFilter to something else (in TraversableLike) to allow it to return objects that don't have to subclass TraversableLike.WithFilter, and reimplement the withFilter method in Stream to simply call `filter` method - in the case of Streams, `withFilter` has little sense in either case...
........
  r22142 | prokopec | 2010-06-02 19:09:39 +0200 (Wed, 02 Jun 2010) | 1 line

  Fixes #3508. No review is necessary.
........
  r22147 | prokopec | 2010-06-03 10:52:01 +0200 (Thu, 03 Jun 2010) | 3 lines

  Fixes #3511 by adding a custom StreamView. review by extempore - please advise if we should keep this or not
........
  r22148 | prokopec | 2010-06-03 10:55:14 +0200 (Thu, 03 Jun 2010) | 1 line

  Forgot to add stream view classes for #3511. review by extempore.
........ r22149 | dubochet | 2010-06-03 11:22:57 +0200 (Thu, 03 Jun
2010) | 1 line

  [scaladoc] Fixed typo in Scaladoc man page (thanks Stéphane). No
review. ........ r22167 | extempore | 2010-06-04 20:34:02 +0200 (Fri, 04
Jun 2010) | 4 lines

  Fix for init-order caused NPE in NumericRange. While I was in there
ran across some tortured logic trying to accomodate the long abandoned
idea of having 5 != 5L, so simplified the contains method. Closes #3518,
no review. ........ r22168 | extempore | 2010-06-04 21:15:10 +0200 (Fri,
04 Jun 2010) | 3 lines

  Tracked down why the jvm/natives.scala fails for me and apparently not
anyone else. Rebuilt libnatives.jnlib to accomodate x86-64, and it seems
to pass. No review. ........ r22174 | michelou | 2010-06-05 21:25:28
+0200 (Sat, 05 Jun 2010) | 2 lines

  added/updated Android examples
........
  r22176 | odersky | 2010-06-06 09:46:43 +0200 (Sun, 06 Jun 2010) | 2 lines

  Overwrote copyToArray for efficiency.
........
  r22177 | odersky | 2010-06-06 09:47:21 +0200 (Sun, 06 Jun 2010) | 2 lines

  Fixed a typo in a use case
........
  r22182 | prokopec | 2010-06-07 12:15:32 +0200 (Mon, 07 Jun 2010) | 2 lines

  Adding parallel collections to trunk.
  sabbus also edited to add parallel collections to the library jar - review by phaller
........
  r22186 | extempore | 2010-06-07 23:00:46 +0200 (Mon, 07 Jun 2010) | 2 lines

  Made scripts wait for all non-daemon threads to exit before calling
System.exit. Closes #1955, #2006, #3408. Review by community. ........
r22188 | extempore | 2010-06-08 01:43:14 +0200 (Tue, 08 Jun 2010) | 4
lines

  Most of the iterate implementations were calling the given function
one too many times, leading to tragic failure if the function could not
handle this (such as repeatedly applying tail.) Closes #3540, review by
prokopec. ........ r22189 | extempore | 2010-06-08 04:15:50 +0200 (Tue,
08 Jun 2010) | 4 lines

  Taking another shot at negative constants as annotation arguments
since r22175 didn't quite get there. I call into the constant folder
with the unfolded tree at the last point before it's going to fail the
compile anyway. Closes #3521, review by odersky. ........ r22194 |
michelou | 2010-06-08 13:13:04 +0200 (Tue, 08 Jun 2010) | 2 lines

  added/updated Android examples (cnt'd)
........
  r22195 | extempore | 2010-06-08 16:35:16 +0200 (Tue, 08 Jun 2010) | 2 lines

  Fixed a regrettable oversight which was leaving temp files stacking up
in templand, and a partial fix for #3519. No review. ........ r22196 |
prokopec | 2010-06-08 18:17:58 +0200 (Tue, 08 Jun 2010) | 1 line

  Fixes #3461. No review.p
........
  r22197 | michelou | 2010-06-08 18:52:51 +0200 (Tue, 08 Jun 2010) | 2 lines

  fixed setenv task (Android examples)
........
  r22198 | extempore | 2010-06-08 21:03:56 +0200 (Tue, 08 Jun 2010) | 3 lines

  Put in some long overdue soft padding around repl completion so when
it pokes around the compiler in a way which surprises something, we
don't lose the repl. Closes #3548, no review. ........ r22199 | prokopec
| 2010-06-09 09:56:13 +0200 (Wed, 09 Jun 2010) | 5 lines

  Added `combine` and `split` to immutable.HashMap.

  Under test/benchmarks there is a `bench` script to run benchmarks - it can be invoked after running building the library.
  Review by rompf.
........
  r22211 | prokopec | 2010-06-10 10:58:07 +0200 (Thu, 10 Jun 2010) | 1 line

  HashMap merge bug fixed. No review
........
  r22215 | prokopec | 2010-06-10 19:47:18 +0200 (Thu, 10 Jun 2010) | 1 line

  Continued working on hash trie map combine - work in progress. No review yet.
........
  r22234 | prokopec | 2010-06-11 17:15:55 +0200 (Fri, 11 Jun 2010) | 2 lines

  Further improved combine for hash tries, cutting of another 30ms (160
downto 130). Review by rompf. ........ r22248 | michelou | 2010-06-12
20:53:45 +0200 (Sat, 12 Jun 2010) | 2 lines

  updated build scripts (Android examples)
........
  r22249 | michelou | 2010-06-12 21:30:16 +0200 (Sat, 12 Jun 2010) | 2 lines

  moved README file (Android examples)
........
  r22260 | extempore | 2010-06-13 18:16:47 +0200 (Sun, 13 Jun 2010) | 1 line

  Changed groupBy to return immutable.Map. Closes #3550, review by
odersky. ........ r22261 | extempore | 2010-06-13 18:17:05 +0200 (Sun,
13 Jun 2010) | 2 lines

  Made getters treated more like private members when debating whether
to inline. Closes #3420, review by dragos. ........ r22276 | dragos |
2010-06-14 14:18:13 +0200 (Mon, 14 Jun 2010) | 1 line

  Closes #3420, typo in scaladoc for BigInt. No review. ........

1 files changed, 68 insertions, 60 deletions

diff --git a/src/manual/scala/man1/scaladoc.scala b/src/manual/scala/man1/scaladoc.scala
index 77a2b88ce7..420bb08c4d 100644
--- a/src/manual/scala/man1/scaladoc.scala
+++ b/src/manual/scala/man1/scaladoc.scala
@@ -1,6 +1,7 @@
 /* NSC -- new Scala compiler
- * Copyright 2005-2010 LAMP/EPFL
+ * Copyright LAMP/EPFL
  * @author Stephane Micheloud
+ * @author Gilles Dubochet
  */
 
 package scala.man1
@@ -44,82 +45,92 @@ object scaladoc extends Command {
     CmdOption("d") & "(see " & Link(Bold("OPTIONS"), "#options") & ", below).",
 
     // tags are defined in class "scala.tools.nsc.doc.DocGenerator"
-    "Supported tag comments are:",
-
-    BulletList(
-      Mono("@author"), Mono("@deprecated"),
-      Mono("@exception") & " (two arguments)",
-      Mono("@param") & " (two arguments)", Mono("@pre"),
-      Mono("@return"), Mono("@see"), Mono("@since"),
-      Mono("@throws") & " (two arguments)",
-      Mono("@todo"), Mono("@version")),
-
-    "See also online document \"" & Link("How to Write Doc Comments for the Javadoc Tool",
-    "http://java.sun.com/j2se/javadoc/writingdoccomments/") & "\" from Sun.")
+    "The recognised format of comments in source is described in the " & Link("online documentation",
+    "http://lampsvn.epfl.ch/trac/scala/wiki/Scaladoc"))
 
   val options = Section("OPTIONS",
 
-    "The generator has a set of standard options that are supported on the " &
-    "current development environment and will be supported in future releases.",
-
     Section("Standard Options",
       DefinitionList(
         Definition(
           CmdOption("d", Argument("directory")),
-          "Specify where to place generated class files."),
+          "Specify where to generate documentation."),
         Definition(
-          CmdOption("access:<access>"),
-          "Show only public, protected/public (default) or all classes " &
-          "and members (" & Mono("public") & ",protected,private)"),
+          CmdOption("version"),
+          "Print product version and exit."),
         Definition(
-          CmdOption("windowtitle", Argument("windowtitle")),
-          "Specify window title of generated HTML documentation"),
+          /*CmdOption("?") & "| " &*/ CmdOption("help"),
+          "Print a synopsis of available options."))),
+
+    Section("Documentation Options",
+      DefinitionList(
         Definition(
-          CmdOption("doctitle", Argument("doctitle")),
-          "Include title for the overview page"),
+          CmdOption("doc-title", Argument("title")),
+          "Define the overall title of the documentation, typically the name of the library being documented."),
         Definition(
-          CmdOption("stylesheetfile", Argument("stylesheetfile")),
-          "File to change style of the generated documentation"),
+          CmdOption("doc-version", Argument("version")),
+          "Define the overall version number of the documentation, typically the version of the library being documented."),
         Definition(
-          CmdOption("header", Argument("pageheader")),
-          "Include header text for each page"),
+          CmdOption("doc-source-url", Argument("url")),
+          "Define a URL to be concatenated with source locations for link to source files."))),
+
+    Section("Compiler Options",
+      DefinitionList(
         Definition(
-          CmdOption("footer", Argument("pagefooter")),
-          "Include footer text for each page"),
+          CmdOption("verbose"),
+          "Output messages about what the compiler is doing"),
         Definition(
-          CmdOption("top", Argument("pagetop")),
-          "Include top text for each page"),
+          CmdOption("deprecation"),
+          SeqPara(
+            "Indicate whether source should be compiled with deprecation " &
+            "information; defaults to " & Mono("off") & " (" &
+            "accepted values are: " & Mono("on") & ", " & Mono("off") &
+            ", " & Mono("yes") & " and " & Mono("no") & ")",
+            "Available since Scala version 2.2.1")),
         Definition(
-          CmdOption("bottom", Argument("pagebottom")),
-          "Include bottom text for each page"),
+          CmdOption("classpath", Argument("path")),
+          SeqPara(
+            "Specify where to find user class files (on Unix-based systems " &
+            "a colon-separated list of paths, on Windows-based systems, a " &
+            "semicolon-separate list of paths). This does not override the " &
+            "built-in (" & Mono("\"boot\"") & ") search path.",
+            "The default class path is the current directory. Setting the " &
+            Mono("CLASSPATH") & " variable or using the " & Mono("-classpath") & " " &
+            "command-line option overrides that default, so if you want to " &
+            "include the current directory in the search path, you must " &
+            "include " & Mono("\".\"") & " in the new settings.")),
         Definition(
-          CmdOption("version"),
-          "Print product version and exit."),
+          CmdOption("sourcepath", Argument("path")),
+          "Specify where to find input source files."),
         Definition(
-          /*CmdOption("?") & "| " &*/ CmdOption("help"),
-          "Print a synopsis of standard options."))))
-
-  val examples = Section("EXAMPLES",
-
-    DefinitionList(
-      Definition(
-        "Generate documentation for a Scala program",
-        CmdLine("HelloWorld.scala")),
-      Definition(
-        "Generation documentation for a Scala program to the destination " &
-        "directory " & Bold("classes"),
-        CmdLine(CmdOption("d", "api") & "HelloWorld.scala")),
-      Definition(
-        "Generate documentation for all Scala files found in the source " &
-        "directory " & Bold("src") & " to the destination directory " &
-        Bold("api"),
-        CmdLine(CmdOption("d", "api") & "src/*.scala"))))
+          CmdOption("bootclasspath", Argument("path")),
+          "Override location of bootstrap class files (where to find the " &
+          "standard built-in classes, such as \"" & Mono("scala.List") & "\")."),
+        Definition(
+          CmdOption("extdirs", Argument("dirs")),
+          "Override location of installed extensions."),
+        Definition(
+          CmdOption("encoding", Argument("encoding")),
+          SeqPara(
+            "Specify character encoding used by source files.",
+            "The default value is platform-specific (Linux: " & Mono("\"UTF8\"") &
+            ", Windows: " & Mono("\"Cp1252\"") & "). Executing the following " &
+            "code in the Scala interpreter will return the default value " &
+            "on your system:",
+            MBold("    scala> ") &
+            Mono("new java.io.InputStreamReader(System.in).getEncoding"))))))
 
   val exitStatus = Section("EXIT STATUS",
 
     MBold(command) & " returns a zero exist status if it succeeds to process " &
     "the specified input files. Non zero is returned in case of failure.")
 
+  override val authors = Section("AUTHORS",
+
+    "This version of Scaladoc was written by Gilles Dubochet with contributions by Pedro Furlanetto and Johannes Rudolph. " &
+    "It is based on the original Scaladoc (Sean McDirmid, Geoffrey Washburn, Vincent Cremet and Stéphane Michleoud), " &
+    "on vScaladoc (David Bernard), as well as on an unreleased version of Scaladoc 2 (Manohar Jonnalagedda).")
+
   val seeAlso = Section("SEE ALSO",
 
     Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
@@ -130,20 +141,17 @@ object scaladoc extends Command {
 
   def manpage = new Document {
     title = command
-    date = "May 1, 2007"
-    author = "Stephane Micheloud"
-    version = "0.4"
+    date = "2 June 2010"
+    author = "Gilles Dubochet"
+    version = "2.0"
     sections = List(
       name,
       synopsis,
       parameters,
       description,
       options,
-      examples,
       exitStatus,
       authors,
-      bugs,
-      copyright,
       seeAlso)
   }
 }