Fixed a number of faulty Scaladoc comments in l...

Fixed a number of faulty Scaladoc comments in library and compiler
sources. No review.

Author: Gilles Dubochet

src/library/scala/xml/Node.scala

@@ -213,9 +213,10 @@ abstract class Node extends NodeSeq {
    *  Martin to Burak: to do: if you make this method abstract, the compiler will now
    *  complain if there's no implementation in a subclass. Is this what we want? Note that
    *  this would break doc/DocGenator and doc/ModelToXML, with an error message like:
-doc\DocGenerator.scala:1219: error: object creation impossible, since there is a deferred declaration of method text in class Node of type => String which is not implemented in a subclass
-    new SpecialNode {
-    ^
-   */
+   * {{{
+   * doc\DocGenerator.scala:1219: error: object creation impossible, since there is a deferred declaration of method text in class Node of type => String which is not implemented in a subclass
+   * new SpecialNode {
+   * ^
+   * }}} */
   override def text: String = super.text
 }

src/library/scala/xml/PrettyPrinter.scala

@@ -23,7 +23,7 @@ import Utility.sbToString
  *  @version 1.0
  *
  *  @param width the width to fit the output into
- *  @step  indentation
+ *  @param step  indentation
  */
 class PrettyPrinter(width: Int, step: Int) {
 

src/library/scala/xml/Utility.scala

@@ -84,7 +84,7 @@ object Utility extends AnyRef with parsing.TokenTests
 
   object Escapes {
     /** For reasons unclear escape and unescape are a long ways from
-        being logical inverses. */
+      * being logical inverses. */
     val pairs = Map(
       "lt"    -> '<',
       "gt"    -> '>',

src/library/scala/xml/dtd/ElementValidator.scala

@@ -95,7 +95,7 @@ class ElementValidator() extends Function1[Node,Boolean] {
   }
 
   /** check children, return true if conform to content model
-   *  @pre contentModel != null
+   *  @note contentModel != null
    */
   def check(nodes: Seq[Node]): Boolean = contentModel match {
     case ANY    => true
@@ -120,7 +120,7 @@ class ElementValidator() extends Function1[Node,Boolean] {
   }
 
   /** applies various validations - accumulates error messages in exc
-   *  @todo: fail on first error, ignore other errors (rearranging conditions)
+   *  @todo fail on first error, ignore other errors (rearranging conditions)
    */
   def apply(n: Node): Boolean =
     //- ? check children

src/library/scala/xml/include/XIncludeException.scala

@@ -43,7 +43,7 @@ class XIncludeException(message: String) extends Exception(message) {
    * This method allows you to store the original exception.
    *
    * @param   nestedException   the underlying exception which
-   caused the XIncludeException to be thrown
+   * caused the XIncludeException to be thrown
    */
   def setRootCause(nestedException: Throwable ) {
     this.rootCause = nestedException

src/library/scala/xml/parsing/ConstructingParser.scala

@@ -25,28 +25,27 @@ object ConstructingParser {
 }
 
 /** An xml parser. parses XML and invokes callback methods of a MarkupHandler.
- *  Don't forget to call next.ch on a freshly instantiated parser in order to
- *  initialize it. If you get the parser from the object method, initialization
- *  is already done for you.
- *
- *<pre>
-object parseFromURL {
-  def main(args:Array[String]): Unit = {
-    val url = args(0);
-    val src = scala.io.Source.fromURL(url);
-    val cpa = scala.xml.parsing.ConstructingParser.fromSource(src, false); // fromSource initializes automatically
-    val doc = cpa.document();
-
-    // let's see what it is
-    val ppr = new scala.xml.PrettyPrinter(80,5);
-    val ele = doc.docElem;
-    Console.println("finished parsing");
-    val out = ppr.format(ele);
-    Console.println(out);
-  }
-}
-</pre>
- */
+  * Don't forget to call next.ch on a freshly instantiated parser in order to
+  * initialize it. If you get the parser from the object method, initialization
+  * is already done for you.
+  *
+  * {{{
+  * object parseFromURL {
+  *   def main(args:Array[String]): Unit = {
+  *     val url = args(0);
+  *     val src = scala.io.Source.fromURL(url);
+  *     val cpa = scala.xml.parsing.ConstructingParser.fromSource(src, false); // fromSource initializes automatically
+  *     val doc = cpa.document();
+  *
+  *     // let's see what it is
+  *     val ppr = new scala.xml.PrettyPrinter(80,5);
+  *     val ele = doc.docElem;
+  *     Console.println("finished parsing");
+  *     val out = ppr.format(ele);
+  *     Console.println(out);
+  *   }
+  * }
+  * }}} */
 class ConstructingParser(val input: Source, val preserveWS: Boolean)
 extends  ConstructingHandler
 with     ExternalSources

src/library/scala/xml/parsing/MarkupParser.scala

@@ -719,8 +719,7 @@ trait MarkupParser extends MarkupParserCommon with TokenTests
       nextch
   }
 
-  /**  "rec-xml/#ExtSubset" pe references may not occur within markup
-   declarations
+  /**  "rec-xml/#ExtSubset" pe references may not occur within markup declarations
    */
   def intSubset() {
     //Console.println("(DEBUG) intSubset()")