summaryrefslogtreecommitdiff
path: root/src/library/scala/Option.scala
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/Option.scala
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/Option.scala')
-rw-r--r--src/library/scala/Option.scala2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/library/scala/Option.scala b/src/library/scala/Option.scala
index 44c8fba45f..c461b413d6 100644
--- a/src/library/scala/Option.scala
+++ b/src/library/scala/Option.scala
@@ -146,7 +146,7 @@ sealed abstract class Option[+A] extends Product with Serializable {
/** Returns the result of applying $f to this $option's
* value if the $option is nonempty. Otherwise, evaluates
- * expression $ifEmpty.
+ * expression `ifEmpty`.
*
* @note This is equivalent to `$option map f getOrElse ifEmpty`.
*