Skip to content

Commit b977b01

Browse files
committed
fix Scaladoc warnings, now that warnings are fatal
1 parent 122c82d commit b977b01

File tree

5 files changed

+16
-1
lines changed

5 files changed

+16
-1
lines changed

core/src/main/scala/scala/collection/generic/ParFactory.scala

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import scala.language.higherKinds
1717
* thereof. This class extends `TraversableFactory` and provides a set of
1818
* operations to create `$Coll` objects.
1919
*
20+
* @define factoryInfo
21+
* This object provides a set of operations needed to create `$Coll` values.
2022
* @define coll parallel collection
2123
* @define Coll `ParIterable`
2224
* @since 2.8

core/src/main/scala/scala/collection/generic/ParMapFactory.scala

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import scala.language.higherKinds
2222
*
2323
* @define coll parallel map
2424
* @define Coll `ParMap`
25+
* @define factoryInfo
26+
* This object provides a set of operations needed to create `$Coll` values.
2527
* @author Aleksandar Prokopec
2628
* @since 2.8
2729
*/

core/src/main/scala/scala/collection/generic/ParSetFactory.scala

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ import scala.collection.parallel.ParSetLike
1616
import scala.language.higherKinds
1717

1818
/**
19+
* @define factoryInfo
20+
* This object provides a set of operations needed to create `$Coll` values.
1921
* @author Aleksandar Prokopec
2022
* @since 2.8
2123
*/

core/src/main/scala/scala/collection/parallel/ParIterableLike.scala

+5-1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ import scala.collection.parallel.ParallelCollectionImplicits._
3939
* @tparam T the element type of the collection
4040
* @tparam Repr the type of the actual collection containing the elements
4141
*
42+
* @define undefinedorder
43+
* The order in which operations are performed on elements is unspecified
44+
* and may be nondeterministic.
45+
*
4246
* @define paralleliterableinfo
4347
* This is a base trait for Scala parallel collections. It defines behaviour
4448
* common to all parallel collections. Concrete parallel collections should
@@ -714,7 +718,7 @@ self: ParIterableLike[T, Repr, Sequential] =>
714718
* @tparam That type of the resulting collection
715719
* @param z neutral element for the operator `op`
716720
* @param op the associative operator for the scan
717-
* @param bf $bfinfo
721+
* @param bf $pbfinfo
718722
* @return a collection containing the prefix scan of the elements in the original collection
719723
*
720724
* @usecase def scan(z: T)(op: (T, T) => T): $Coll[T]

core/src/main/scala/scala/collection/parallel/ParSeqLike.scala

+5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ import scala.collection.parallel.ParallelCollectionImplicits._
3535
* nondeterministic. If the higher-order functions given to them produce no sideeffects,
3636
* then this won't be noticeable.
3737
*
38+
* @define mayNotTerminateInf
39+
* Note: may not terminate for infinite-sized collections.
40+
* @define willNotTerminateInf
41+
* Note: will not terminate for infinite-sized collections.
42+
*
3843
* This trait defines a new, more general `split` operation and reimplements the `split`
3944
* operation of `ParallelIterable` trait using the new `split` operation.
4045
*

0 commit comments

Comments
 (0)