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/parallel/ParSeqLike.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/parallel/ParSeqLike.scala')
-rw-r--r-- | src/library/scala/collection/parallel/ParSeqLike.scala | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/src/library/scala/collection/parallel/ParSeqLike.scala b/src/library/scala/collection/parallel/ParSeqLike.scala index b3c527da84..be5ab03ba7 100644 --- a/src/library/scala/collection/parallel/ParSeqLike.scala +++ b/src/library/scala/collection/parallel/ParSeqLike.scala @@ -162,7 +162,7 @@ self => * * $abortsignalling * - * @tparam U the element type of `that` parallel sequence + * @tparam S the element type of `that` parallel sequence * @param that the parallel sequence this sequence is being searched for * @param offset the starting offset for the search * @return `true` if there is a sequence `that` starting at `offset` in this sequence, `false` otherwise @@ -287,9 +287,7 @@ self => /** Computes the multiset intersection between this $coll and another sequence. * * @param that the sequence of elements to intersect with. - * @tparam B the element type of the returned $coll. - * @tparam That $thatinfo - * @param bf $bfinfo + * @tparam U the element type of `that` parallel sequence * @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 |