From 2e35400ffbb1a9702f5fa8c92199d14101415631 Mon Sep 17 00:00:00 2001 From: Jacek Centkowski Date: Fri, 27 Oct 2023 17:38:08 +0200 Subject: [PATCH] fix: class references in scaladoc --- core/src/main/scala/ox/channels/SourceOps.scala | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/core/src/main/scala/ox/channels/SourceOps.scala b/core/src/main/scala/ox/channels/SourceOps.scala index 152e8038..1ea8e205 100644 --- a/core/src/main/scala/ox/channels/SourceOps.scala +++ b/core/src/main/scala/ox/channels/SourceOps.scala @@ -514,13 +514,13 @@ trait SourceOps[+T] { this: Source[T] => } c - /** Returns the first element from this source wrapped in `Some` or `None` when the source is empty. Note that `headOption` is not an + /** Returns the first element from this source wrapped in [[Some]] or [[None]] when the source is empty. Note that `headOption` is not an * idempotent operation on source as it receives elements from it. * * @return * A `Some(first element)` if source is not empty or `None` otherwise. * @throws ChannelClosedException.Error - * When `receive()` fails. + * When [[receive]] fails. * @example * {{{ * import ox.* @@ -542,16 +542,16 @@ trait SourceOps[+T] { this: Source[T] => case t: T @unchecked => Some(t) } - /** Returns the first element from this source or throws `NoSuchElementException` when the source is empty. In case when the `receive()` - * operation fails with exception then `ChannelClosedException.Error`` thrown. Note that `headOption` is not an idempotent operation on + /** Returns the first element from this source or throws [[NoSuchElementException]] when the source is empty. In case when the [[receive]] + * operation fails with exception then [[ChannelClosedException.Error]] is thrown. Note that `head` is not an idempotent operation on * source as it receives elements from it. * * @return * A first element if source is not empty or throws otherwise. * @throws NoSuchElementException - * When source is empty or `receive()` failed without error. + * When a source is empty. * @throws ChannelClosedException.Error - * When `receive()` fails. + * When [[receive]] fails. * @example * {{{ * import ox.*