Skip to content

Commit 7a1086d

Browse files
fix: class references in scaladoc
1 parent 944a5e1 commit 7a1086d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

core/src/main/scala/ox/channels/SourceOps.scala

+6-6
Original file line numberDiff line numberDiff line change
@@ -514,13 +514,13 @@ trait SourceOps[+T] { this: Source[T] =>
514514
}
515515
c
516516

517-
/** Returns the first element from this source wrapped in `Some` or `None` when the source is empty. Note that `headOption` is not an
517+
/** Returns the first element from this source wrapped in [[Some]] or [[None]] when the source is empty. Note that `headOption` is not an
518518
* idempotent operation on source as it receives elements from it.
519519
*
520520
* @return
521521
* A `Some(first element)` if source is not empty or `None` otherwise.
522522
* @throws ChannelClosedException.Error
523-
* When `receive()` fails.
523+
* When [[receive]] fails.
524524
* @example
525525
* {{{
526526
* import ox.*
@@ -542,16 +542,16 @@ trait SourceOps[+T] { this: Source[T] =>
542542
case t: T @unchecked => Some(t)
543543
}
544544

545-
/** Returns the first element from this source or throws `NoSuchElementException` when the source is empty. In case when the `receive()`
546-
* operation fails with exception then `ChannelClosedException.Error`` thrown. Note that `headOption` is not an idempotent operation on
545+
/** Returns the first element from this source or throws [[NoSuchElementException]] when the source is empty. In case when the [[receive]]
546+
* operation fails with exception then [[ChannelClosedException.Error]] is thrown. Note that `head` is not an idempotent operation on
547547
* source as it receives elements from it.
548548
*
549549
* @return
550550
* A first element if source is not empty or throws otherwise.
551551
* @throws NoSuchElementException
552-
* When source is empty or `receive()` failed without error.
552+
* When a source is empty.
553553
* @throws ChannelClosedException.Error
554-
* When `receive()` fails.
554+
* When [[receive]] fails.
555555
* @example
556556
* {{{
557557
* import ox.*

0 commit comments

Comments
 (0)