summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/convert
diff options
context:
space:
mode:
authorJason Zaugg <jzaugg@gmail.com>2012-05-13 12:24:24 +0200
committerJason Zaugg <jzaugg@gmail.com>2012-05-13 13:28:12 +0200
commit4af770340b64e1124c1ed4623c7d5a734cf602a1 (patch)
tree479f571bb8dc7ab847ba2bd12dae82be2ab83c1f /src/library/scala/collection/convert
parent4cd0253d0d461d01672334d240bc5249027f536b (diff)
downloadscala-4af770340b64e1124c1ed4623c7d5a734cf602a1.tar.gz
scala-4af770340b64e1124c1ed4623c7d5a734cf602a1.tar.bz2
scala-4af770340b64e1124c1ed4623c7d5a734cf602a1.zip
Address doc comment rot in the standard library.
- Match @param/@tparam names to the actual parameter name - Use @tparam for type parameters - Whitespace is required between `*` and `@` - Fix incorrect references to @define macros. - Use of monospace `` and {{{}}} (much more needed) - Remove `@param p1 ...` stubs, which appear in the generated docss. - But, retainsed `@param p1` stubs, assuming they will be filtered from the generated docs by SI-5795. - Avoid use of the shorthand `@param doc for the solitary param` (which works, but isn't recognized by the code inspection in IntelliJ I used to sweep through the problems) The remaining warnings from `ant docs` seem spurious, I suspect they are an unintended consequence of documenting extension methods. [scaladoc] /Users/jason/code/scala/src/library/scala/collection/TraversableOnce.scala:181: warning: Variable coll undefined in comment for method reduceOption in class Tuple2Zipped [scaladoc] def reduceOption[A1 >: A](op: (A1, A1) => A1): Option[A1] = reduceLeftOption(op) [scaladoc] ^
Diffstat (limited to 'src/library/scala/collection/convert')
-rw-r--r--src/library/scala/collection/convert/DecorateAsScala.scala12
-rw-r--r--src/library/scala/collection/convert/WrapAsJava.scala20
-rw-r--r--src/library/scala/collection/convert/WrapAsScala.scala12
3 files changed, 22 insertions, 22 deletions
diff --git a/src/library/scala/collection/convert/DecorateAsScala.scala b/src/library/scala/collection/convert/DecorateAsScala.scala
index b170d8d139..539584b148 100644
--- a/src/library/scala/collection/convert/DecorateAsScala.scala
+++ b/src/library/scala/collection/convert/DecorateAsScala.scala
@@ -186,9 +186,9 @@ trait DecorateAsScala {
* any side-effects of using it via the Scala interface will be visible via
* the Java interface and vice versa.
*
- * @param m The `Dictionary` to be converted.
- * @return An object with an `asScala` method that returns a Scala mutable
- * `Map[String, String]` view of the argument.
+ * @param p The `Dictionary` to be converted.
+ * @return An object with an `asScala` method that returns a Scala mutable
+ * `Map[String, String]` view of the argument.
*/
implicit def dictionaryAsScalaMapConverter[A, B](p: ju.Dictionary[A, B]): AsScala[mutable.Map[A, B]] =
new AsScala(dictionaryAsScalaMap(p))
@@ -200,9 +200,9 @@ trait DecorateAsScala {
* any side-effects of using it via the Scala interface will be visible via
* the Java interface and vice versa.
*
- * @param m The `Properties` to be converted.
- * @return An object with an `asScala` method that returns a Scala mutable
- * `Map[String, String]` view of the argument.
+ * @param p The `Properties` to be converted.
+ * @return An object with an `asScala` method that returns a Scala mutable
+ * `Map[String, String]` view of the argument.
*/
implicit def propertiesAsScalaMapConverter(p: ju.Properties): AsScala[mutable.Map[String, String]] =
new AsScala(propertiesAsScalaMap(p))
diff --git a/src/library/scala/collection/convert/WrapAsJava.scala b/src/library/scala/collection/convert/WrapAsJava.scala
index ecf91deb3a..fcfe402a68 100644
--- a/src/library/scala/collection/convert/WrapAsJava.scala
+++ b/src/library/scala/collection/convert/WrapAsJava.scala
@@ -24,8 +24,8 @@ trait WrapAsJava {
* explicit call of `asIterator(java.util.Iterator)` then the original
* Java Iterator will be returned.
*
- * @param i The Iterator to be converted.
- * @return A Java Iterator view of the argument.
+ * @param it The Iterator to be converted.
+ * @return A Java Iterator view of the argument.
*/
implicit def asJavaIterator[A](it: Iterator[A]): ju.Iterator[A] = it match {
case JIteratorWrapper(wrapped) => wrapped.asInstanceOf[ju.Iterator[A]]
@@ -42,8 +42,8 @@ trait WrapAsJava {
* explicit call of `asIterator(java.util.Enumeration)` then the
* original Java Enumeration will be returned.
*
- * @param i The Iterator to be converted.
- * @return A Java Enumeration view of the argument.
+ * @param it The Iterator to be converted.
+ * @return A Java Enumeration view of the argument.
*/
implicit def asJavaEnumeration[A](it: Iterator[A]): ju.Enumeration[A] = it match {
case JEnumerationWrapper(wrapped) => wrapped.asInstanceOf[ju.Enumeration[A]]
@@ -76,8 +76,8 @@ trait WrapAsJava {
* explicit call of `asSizedIterable(java.util.Collection)` then the original
* Java Collection will be returned.
*
- * @param i The SizedIterable to be converted.
- * @return A Java Collection view of the argument.
+ * @param it The SizedIterable to be converted.
+ * @return A Java Collection view of the argument.
*/
implicit def asJavaCollection[A](it: Iterable[A]): ju.Collection[A] = it match {
case JCollectionWrapper(wrapped) => wrapped.asInstanceOf[ju.Collection[A]]
@@ -112,8 +112,8 @@ trait WrapAsJava {
* explicit call of `asSeq(java.util.List)` then the original
* Java List will be returned.
*
- * @param b The Seq to be converted.
- * @return A Java List view of the argument.
+ * @param seq The Seq to be converted.
+ * @return A Java List view of the argument.
*/
implicit def mutableSeqAsJavaList[A](seq: mutable.Seq[A]): ju.List[A] = seq match {
case JListWrapper(wrapped) => wrapped
@@ -130,8 +130,8 @@ trait WrapAsJava {
* explicit call of `asSeq(java.util.List)` then the original
* Java List will be returned.
*
- * @param b The Seq to be converted.
- * @return A Java List view of the argument.
+ * @param seq The Seq to be converted.
+ * @return A Java List view of the argument.
*/
implicit def seqAsJavaList[A](seq: Seq[A]): ju.List[A] = seq match {
case JListWrapper(wrapped) => wrapped.asInstanceOf[ju.List[A]]
diff --git a/src/library/scala/collection/convert/WrapAsScala.scala b/src/library/scala/collection/convert/WrapAsScala.scala
index 14c64695ff..49f4d7cd99 100644
--- a/src/library/scala/collection/convert/WrapAsScala.scala
+++ b/src/library/scala/collection/convert/WrapAsScala.scala
@@ -25,8 +25,8 @@ trait WrapAsScala {
* explicit call of `asIterator(scala.collection.Iterator)` then the
* original Scala `Iterator` will be returned.
*
- * @param i The `Iterator` to be converted.
- * @return A Scala `Iterator` view of the argument.
+ * @param it The `Iterator` to be converted.
+ * @return A Scala `Iterator` view of the argument.
*/
implicit def asScalaIterator[A](it: ju.Iterator[A]): Iterator[A] = it match {
case IteratorWrapper(wrapped) => wrapped
@@ -187,8 +187,8 @@ trait WrapAsScala {
* `Dictionary` and any side-effects of using it via the Scala interface
* will be visible via the Java interface and vice versa.
*
- * @param m The Dictionary to be converted.
- * @return A Scala mutable Map[String, String] view of the argument.
+ * @param p The Dictionary to be converted.
+ * @return A Scala mutable Map[String, String] view of the argument.
*/
implicit def dictionaryAsScalaMap[A, B](p: ju.Dictionary[A, B]): mutable.Map[A, B] = p match {
case DictionaryWrapper(wrapped) => wrapped
@@ -202,8 +202,8 @@ trait WrapAsScala {
* `Properties` and any side-effects of using it via the Scala interface
* will be visible via the Java interface and vice versa.
*
- * @param m The Properties to be converted.
- * @return A Scala mutable Map[String, String] view of the argument.
+ * @param p The Properties to be converted.
+ * @return A Scala mutable Map[String, String] view of the argument.
*/
implicit def propertiesAsScalaMap(p: ju.Properties): mutable.Map[String, String] = p match {
case _ => new JPropertiesWrapper(p)