diff options
| author | Jason Zaugg <jzaugg@gmail.com> | 2012-05-13 12:24:24 +0200 |
|---|---|---|
| committer | Jason Zaugg <jzaugg@gmail.com> | 2012-05-13 13:28:12 +0200 |
| commit | 4af770340b64e1124c1ed4623c7d5a734cf602a1 (patch) | |
| tree | 479f571bb8dc7ab847ba2bd12dae82be2ab83c1f /src/library/scala/collection/GenSeqLike.scala | |
| parent | 4cd0253d0d461d01672334d240bc5249027f536b (diff) | |
| download | scala-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/GenSeqLike.scala')
| -rw-r--r-- | src/library/scala/collection/GenSeqLike.scala | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/src/library/scala/collection/GenSeqLike.scala b/src/library/scala/collection/GenSeqLike.scala index fd7892c9f9..cfa0ca101e 100644 --- a/src/library/scala/collection/GenSeqLike.scala +++ b/src/library/scala/collection/GenSeqLike.scala @@ -413,8 +413,6 @@ trait GenSeqLike[+A, +Repr] extends Any with GenIterableLike[A, Repr] with Equal * * @param that the sequence of elements to remove * @tparam B the element type of the returned $coll. - * @tparam That $thatinfo - * @param bf $bfinfo * @return a new collection of type `That` which contains all elements of this $coll * except some of occurrences of elements that also appear in `that`. * If an element value `x` appears @@ -438,8 +436,6 @@ trait GenSeqLike[+A, +Repr] extends Any with GenIterableLike[A, Repr] with Equal * * @param that the sequence of elements to intersect with. * @tparam B the element type of the returned $coll. - * @tparam That $thatinfo - * @param bf $bfinfo * @return a new collection of type `That` which contains all elements of this $coll * which also appear in `that`. * If an element value `x` appears |