- Fixed some comments in the library that were ...

- Fixed some comments in the library that were not valid XHTML.

8 files changed, 30 insertions, 26 deletions

diff --git a/sources/scala/List.scala b/sources/scala/List.scala
index 9580678205..35c0cf0d6a 100644
--- a/sources/scala/List.scala
+++ b/sources/scala/List.scala
@@ -155,8 +155,8 @@ trait List[+a] extends Seq[a] {
   def tail: List[a];
 
   /** Add an element <code>x</code> at the beginning of this list.
-   *  <p>
-   *  Ex:<br>
+   *  <p/>
+   *  Ex:<br/>
    *  <code>1 :: [2, 3] = [2, 3].::(1) = [1, 2, 3]</code>.
    *  @param x the element to append.
    *  @return the list with <code>x</code> appended at the beginning.
@@ -166,8 +166,8 @@ trait List[+a] extends Seq[a] {
 
   /** Returns a list resulting from the concatenation of the given
    *  list <code>prefix</code> and this list.
-   *  <p>
-   *  Ex:<br>
+   *  <p/>
+   *  Ex:<br/>
    *  <code>[1, 2] ::: [3, 4] = [3, 4].:::([1, 2]) = [1, 2, 3, 4]</code>.
    *  @param prefix the list to concatenate at the beginning of this list.
    *  @return the concatenation of the two lists.
@@ -420,7 +420,7 @@ trait List[+a] extends Seq[a] {
   };
 
   /** Sort the list according to the comparison function
-   *  <(e1: a, e2: a) => Boolean,
+   *  &lt;(e1: a, e2: a) => Boolean,
    *  which should be true iff e1 is smaller than e2.
    *  Note: The current implementation is inefficent for
    *  already sorted lists.
@@ -566,8 +566,8 @@ trait List[+a] extends Seq[a] {
   };
 
   /** Reverses the elements of this list.
-   *  <p>
-   *  Ex: <br>
+   *  <p/>
+   *  Ex: <br/>
    *  <code>[1, 2, 3] reverse = [3, 2, 1]</code>.
    *  @return the elements of this list in reverse order.
    */
@@ -592,8 +592,8 @@ trait List[+a] extends Seq[a] {
    *  <code>end</code>. Inside, the string representations of elements (w.r.t.
    *  the method <code>toString()</code>) are separated by the string
    *  <code>sep</code>.
-   *  <p>
-   *  Ex: <br>
+   *  <p/>
+   *  Ex: <br/>
    *  <code>List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"</code>
    *  @param start starting string.
    *  @param sep separator string.
diff --git a/sources/scala/collection/immutable/Order.scala b/sources/scala/collection/immutable/Order.scala
index 44ad1f2482..3b3ca009c6 100644
--- a/sources/scala/collection/immutable/Order.scala
+++ b/sources/scala/collection/immutable/Order.scala
@@ -30,13 +30,16 @@ object Order {
   */
   def make[A](inferiority:(A,A) => Boolean, equality:(A,A) => Boolean) =
     new Order[A](inferiority,equality);
+
   /**
-  *  Creates a 'standard' order between objects. <strong>NOTE:</strong>
-  *  The order is arbitrary and uses the <code>hashCode()</code> of
-  *  objects which might mean that the order is not really total
-  *  for some objects <code>(!(e1 &lt; e2) && !(e2 &lt; e1) && !(e1==e2))</code>
-  *  is true. This function should only be used when no other
-  *  comparision predicates can be defined.
+  * Creates a 'standard' order between objects.
+  * <strong>NOTE:</strong>
+  * The order is arbitrary and uses the <code>hashCode()</code> of
+  * objects which might mean that the order is not really total
+  * for some objects
+  * <code>(!(e1 &lt; e2) &amp;&amp; !(e2 &lt; e1) &amp;&amp; !(e1==e2))</code>
+  * is true. This function should only be used when no other
+  * comparision predicates can be defined.
   */
   def make =
     new Order[Any](
diff --git a/sources/scala/collection/immutable/Queue.scala b/sources/scala/collection/immutable/Queue.scala
index f8199b1c52..7a220777c0 100644
--- a/sources/scala/collection/immutable/Queue.scala
+++ b/sources/scala/collection/immutable/Queue.scala
@@ -125,8 +125,8 @@ class Queue[+A](elem: A*) extends Seq[A] {
      *    <code>end</code>. Inside, the string representations of elements (w.r.t.
      *  the method <code>toString()</code>) are separated by the string
      *  <code>sep</code>.
-     *  <p>
-     *  Ex: <br>
+     *  <p/>
+     *  Ex: <br/>
      *  <code>Queue(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"</code>
      *
      *  @param start starting string.
diff --git a/sources/scala/collection/immutable/Tree.scala b/sources/scala/collection/immutable/Tree.scala
index 8f65a2f0b7..12a2c58ccc 100644
--- a/sources/scala/collection/immutable/Tree.scala
+++ b/sources/scala/collection/immutable/Tree.scala
@@ -43,18 +43,18 @@ package scala.collection.immutable;
 ** Balanced Trees. These have no storage overhead compared to plain
 ** unbalanced binary trees, and their performance is in general better
 ** than AVL trees.
-** <p>
+** <p/>
 ** This implementation does not balance the trees after deletions.
 ** Since deletions
 ** don't increase the height of a tree, this should be OK in most
 ** applications. A balance method is provided for those cases
 ** where rebalancing is needed.
-** <p>
+** <p/>
 ** The tree consists of entries conatining a key with an order.
 ** Concrete implementations of the tree class has to suply the
 ** function entryKey that given an entry in the tree return
 ** its key.
-** <p>
+** <p/>
 ** When instanciating the tree an order for the keys has to be
 ** supplied.
 **
@@ -129,7 +129,7 @@ abstract class Tree[KEY,Entry](order:Order[KEY]) {
 
   /**
   *   A new tree with the entry added is returned,
-  *   assuming that key is <emph>not</emph> in the tree.
+  *   assuming that key is <em>not</em> in the tree.
   */
   def add(key:KEY,entry:Entry):This = {
     val newSize = size+1;
@@ -141,7 +141,7 @@ abstract class Tree[KEY,Entry](order:Order[KEY]) {
 
   /**
   *   A new tree with the entry added is returned,
-  *   if key is <emph>not</emph> in the tree, otherwise
+  *   if key is <em>not</em> in the tree, otherwise
   *   the key is updated with the new entry.
   */
   def update_or_add(key:KEY, entry:Entry):This = {
diff --git a/sources/scala/collection/immutable/TreeMap.scala b/sources/scala/collection/immutable/TreeMap.scala
index 2473ed9118..7c9ffefc62 100644
--- a/sources/scala/collection/immutable/TreeMap.scala
+++ b/sources/scala/collection/immutable/TreeMap.scala
@@ -39,14 +39,14 @@ package scala.collection.immutable;
 
    /**
    *   A new TreeMap with the entry added is returned,
-   *   if key is <emph>not</emph> in the TreeMap, otherwise
+   *   if key is <em>not</em> in the TreeMap, otherwise
    *   the key is updated with the new entry.
    */
    def update(key:KEY, value:VALUE) = update_or_add(key,Pair(key,value));
 
    /**
    *   A new TreeMap with the entry added is returned,
-   *   assuming that key is <emph>not</emph> in the TreeMap.
+   *   assuming that key is <em>not</em> in the TreeMap.
    */
    def insert(key:KEY,value:VALUE) = add(key,Pair(key,value));
 
diff --git a/sources/scala/collection/mutable/HashTable.scala b/sources/scala/collection/mutable/HashTable.scala
index 4795fc5339..51b259f312 100644
--- a/sources/scala/collection/mutable/HashTable.scala
+++ b/sources/scala/collection/mutable/HashTable.scala
@@ -15,7 +15,7 @@ package scala.collection.mutable;
  *  that maps keys of type <code>A</code> to values of the fully abstract
  *  member type <code>Entry</code>. Classes that make use of <code>HashTable</code>
  *  have to provide an implementation for <code>Entry</code> and implement the
- *  function <code>entryKey</code>.<p>
+ *  function <code>entryKey</code>.<p/>
  *
  *  There are mainly two parameters that affect the performance of a hashtable:
  *  the <i>initial size</i> and the <i>load factor</i>. The <i>size</i>
diff --git a/sources/scala/concurrent/pilib.scala b/sources/scala/concurrent/pilib.scala
index 635fa4ddbc..0bcd19ad45 100644
--- a/sources/scala/concurrent/pilib.scala
+++ b/sources/scala/concurrent/pilib.scala
@@ -9,7 +9,7 @@ object pilib {
 
   /**
   * Run several processes in parallel using the following syntax:
-  * spawn < p_1 | ... | p_n >
+  * spawn &lt; p_1 | ... | p_n &gt;
   */
   trait Spawn {
     def <(def p: unit): Spawn;
diff --git a/sources/scala/tools/scaladoc/Comment.java b/sources/scala/tools/scaladoc/Comment.java
index fe75bb0738..f0895b207c 100644
--- a/sources/scala/tools/scaladoc/Comment.java
+++ b/sources/scala/tools/scaladoc/Comment.java
@@ -203,6 +203,7 @@ public class Comment extends DefaultHandler {
         String msg = "";
         msg += "documentation comments should be written in XHTML" + "\n";
         msg += e.getMessage() + "\n";
+        msg += rawText;
         if (unit != null)
             unit.warning(holder.pos, msg);
     }