Skip to content

Commit 4e50524

Browse files
committed
Add experimental badge to UnicastSubject scaladoc
1 parent 5109a06 commit 4e50524

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

src/main/scala/rx/lang/scala/subjects/UnicastSubject.scala

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,29 @@ import rx.annotations.Experimental
1919
import rx.lang.scala.Subject
2020

2121
/**
22-
* A `Subject` variant which buffers events until a single `Subscriber` arrives and replays them to it
23-
* and potentially switches to direct delivery once the `Subscriber` caught up and requested an unlimited
24-
* amount. In this case, the buffered values are no longer retained. If the `Subscriber`
25-
* requests a limited amount, queueing is involved and only those values are retained which
26-
* weren't requested by the `Subscriber` at that time.
22+
* $experimental A `Subject` variant which buffers events until a single `Subscriber` arrives and replays
23+
* them to it and potentially switches to direct delivery once the `Subscriber` caught up and requested an
24+
* unlimited amount. In this case, the buffered values are no longer retained. If the `Subscriber` requests
25+
* a limited amount, queueing is involved and only those values are retained which weren't requested by the
26+
* `Subscriber` at that time.
27+
*
28+
* @define experimental
29+
* <span class="badge badge-red" style="float: right;">EXPERIMENTAL</span>
2730
*/
2831
@Experimental
2932
object UnicastSubject {
3033

3134
/**
32-
* Constructs an empty `UnicastSubject` instance with the default capacity hint of 16 elements.
35+
* $experimental Constructs an empty `UnicastSubject` instance with the default capacity hint of 16 elements.
3336
*
3437
* @tparam T the input and output value type
3538
* @return the created `UnicastSubject` instance
3639
*/
40+
@Experimental
3741
def apply[T](): UnicastSubject[T] = new UnicastSubject[T](rx.subjects.UnicastSubject.create[T]())
3842

3943
/**
40-
* Constructs an empty UnicastSubject instance with a capacity hint.
44+
* $experimental Constructs an empty UnicastSubject instance with a capacity hint.
4145
* <p>The capacity hint determines the internal queue's island size: the larger
4246
* it is the less frequent allocation will happen if there is no subscriber
4347
* or the subscriber hasn't caught up.
@@ -46,6 +50,7 @@ object UnicastSubject {
4650
* @tparam T the input and output value type
4751
* @return the created `UnicastSubject` instance
4852
*/
53+
@Experimental
4954
def apply[T](capacity: Int): UnicastSubject[T] = new UnicastSubject[T](rx.subjects.UnicastSubject.create(capacity))
5055
}
5156

0 commit comments

Comments
 (0)