From e102fee1b964f866f7b29e2dbf8609e23ccc76ac Mon Sep 17 00:00:00 2001 From: Kato Kazuyoshi Date: Sat, 18 Jun 2011 22:42:00 +0000 Subject: Further ScalaDoc fixes. --- src/library/scala/testing/Show.scala | 32 ++++++++++---------- src/library/scala/util/matching/Regex.scala | 6 ++-- src/library/scala/util/parsing/ast/Binders.scala | 6 ++-- .../parsing/combinator/lexical/StdLexical.scala | 34 ++++++++++------------ 4 files changed, 39 insertions(+), 39 deletions(-) diff --git a/src/library/scala/testing/Show.scala b/src/library/scala/testing/Show.scala index 083653b7c3..f5670ac11a 100644 --- a/src/library/scala/testing/Show.scala +++ b/src/library/scala/testing/Show.scala @@ -10,24 +10,25 @@ package scala.testing -/**

- * Classes inheriting trait Show can test their member methods - * using the notattion meth(arg1, ..., argn), - * where meth is the name of the method and - * arg1,...,argn are the arguments. - * The only difference to a normal method call is the leading quote - * character ('). A quoted method call like the one above will produces a - * legible diagnostic to be printed on Console. It is of the form - * 

+/** Classes inheriting trait `Show` can test their member methods
+ *  using the notattion meth(arg1, ..., argn),
+ *  where `meth` is the name of the method and
+ *  arg1,...,argn are the arguments.
+ *
+ *  The only difference to a normal method call is the leading quote
+ *  character (`'`). A quoted method call like the one above will produces a
+ *  legible diagnostic to be printed on [[scala.Console]].
+ *
+ *  It is of the form
+ *  
  *    meth(arg1, ..., argn)  gives  <result>

- *  

- *    where <result> is the result of evaluating the call.
- *  

+ *
+ *  where <result> is the result of evaluating the call.
+ *
  */
 trait Show {
 
-  /** The result class of wrapper symApply.
+  /** The result class of wrapper `symApply`.
    *  Prints out diagnostics of method applications.
    */
   class SymApply(f: Symbol) {
@@ -36,8 +37,7 @@ trait Show {
     }
   }
 
-  /** An implicit definition that adds an apply method to Symbol which forwards to `test`.
-   */
+  /** An implicit definition that adds an apply method to Symbol which forwards to `test`. */
   implicit def symApply(sym: Symbol) = new SymApply(sym)
 
   /** Apply method with name of given symbol `f` to given arguments and return
diff --git a/src/library/scala/util/matching/Regex.scala b/src/library/scala/util/matching/Regex.scala
index 9ee2b37bbf..7de4587724 100644
--- a/src/library/scala/util/matching/Regex.scala
+++ b/src/library/scala/util/matching/Regex.scala
@@ -15,9 +15,11 @@ import java.util.regex.{ Pattern, Matcher }
 /** This class provides methods for creating and using regular expressions.
  *  It is based on the regular expressions of the JDK since 1.4.
  *
- *  You can use special pattern syntax construct `(?idmsux-idmsux)` to switch
+ *  You can use special pattern syntax constructs like `(?idmsux-idmsux)`¹ to switch
  *  various regex compilation options like `CASE_INSENSITIVE` or `UNICODE_CASE`.
- *  See [[java.util.regex.Pattern]] for details.
+ *
+ *  @note ¹ A detailed description is available in [[java.util.regex.Pattern]].
+ *  @see [[java.util.regex.Pattern]]
  *
  *  @author  Thibaud Hottelier
  *  @author  Philipp Haller
diff --git a/src/library/scala/util/parsing/ast/Binders.scala b/src/library/scala/util/parsing/ast/Binders.scala
index c7b527984d..2687283b76 100644
--- a/src/library/scala/util/parsing/ast/Binders.scala
+++ b/src/library/scala/util/parsing/ast/Binders.scala
@@ -15,12 +15,12 @@ import scala.collection.mutable.Map
   // TODO: avoid clashes when substituting
   // TODO: check binders in the same scope are distinct
 
-/** This trait provides the core Scrap-Your-Boilerplate abstractions as
+/** This trait provides the core ''Scrap-Your-Boilerplate'' abstractions as
  *  well as implementations for common datatypes.
  *
- *  Based on Ralph Laemmel's [[http://homepages.cwi.nl/~ralf/publications.html SYB papers]].
+ *  (Based on Ralf Lämmel's [[http://homepages.cwi.nl/~ralf/syb3/ SYB papers]].)
  *
- * @author Adriaan Moors
+ *  @author Adriaan Moors
  */
 trait Mappable {
   trait Mapper { def apply[T <% Mappable[T]](x: T): T } /* TODO: having type `Forall T. T => T` is too strict:
diff --git a/src/library/scala/util/parsing/combinator/lexical/StdLexical.scala b/src/library/scala/util/parsing/combinator/lexical/StdLexical.scala
index 8ff0ff4321..68636b8f31 100644
--- a/src/library/scala/util/parsing/combinator/lexical/StdLexical.scala
+++ b/src/library/scala/util/parsing/combinator/lexical/StdLexical.scala
@@ -16,22 +16,20 @@ import token._
 import input.CharArrayReader.EofCh
 import collection.mutable.HashSet
 
-/** 

- *    This component provides a standard lexical parser for a simple, Scala-like language.
- *    It parses keywords and identifiers, numeric literals (integers), strings, and delimiters.
- *  

- *  

- *    To distinguish between identifiers and keywords, it uses a set of reserved identifiers:
- *    every string contained in `reserved` is returned as a keyword token.
- *    (Note that "=>" is hard-coded as a keyword.)
- *    Additionally, the kinds of delimiters can be specified by the `delimiters` set.
- *  

- *  

- *    Usually this component is used to break character-based input into bigger tokens,
- *    which are then passed to a token-parser {@see TokenParsers}.
- *  

+/** This component provides a standard lexical parser for a simple, Scala-like language.
+ *  It parses keywords and identifiers, numeric literals (integers), strings, and delimiters.
  *
- * @author Martin Odersky, Iulian Dragos, Adriaan Moors
+ *  To distinguish between identifiers and keywords, it uses a set of reserved identifiers:
+ *  every string contained in `reserved` is returned as a keyword token.
+ *  (Note that "=>" is hard-coded as a keyword.)
+ *  Additionally, the kinds of delimiters can be specified by the `delimiters` set.
+ *
+ *  Usually this component is used to break character-based input into bigger tokens,
+ *  which are then passed to a token-parser {@see TokenParsers}.
+ *
+ * @author Martin Odersky
+ * @author Iulian Dragos
+ * @author Adriaan Moors
  */
 class StdLexical extends Lexical with StdTokens {
   // see `token` in `Scanners`
@@ -47,7 +45,7 @@ class StdLexical extends Lexical with StdTokens {
     | failure("illegal character")
     )
 
-  // legal identifier chars other than digits
+  /** Returns the legal identifier chars, except digits. */
   def identChar = letter | elem('_')
 
   // see `whitespace in `Scanners`
@@ -63,10 +61,10 @@ class StdLexical extends Lexical with StdTokens {
     | chrExcept(EofCh) ~ comment
     )
 
-  /** The set of reserved identifiers: these will be returned as `Keyword`s */
+  /** The set of reserved identifiers: these will be returned as `Keyword`s. */
   val reserved = new HashSet[String]
 
-  /** The set of delimiters (ordering does not matter) */
+  /** The set of delimiters (ordering does not matter). */
   val delimiters = new HashSet[String]
 
   protected def processIdent(name: String) =
-- 
cgit v1.2.3