From 83ee60e5d2802b440210a8a5458e254ce3dc994c Mon Sep 17 00:00:00 2001 From: Nikita Gazarov Date: Thu, 16 Jan 2025 01:37:10 -0800 Subject: [PATCH] Docs: Fix code formatting in Scaladoc --- .../airstream/split/SplitMatchOneMacros.scala | 10 ++--- .../split/SplitMatchOneTypeObservable.scala | 40 +++++++++---------- .../split/SplitMatchOneValueObservable.scala | 40 +++++++++---------- .../debug/DebuggableObservable.scala | 4 +- .../airstream/debug/DebuggableSignal.scala | 4 +- .../com/raquo/airstream/misc/DropStream.scala | 2 +- .../airstream/timing/PeriodicStream.scala | 2 +- 7 files changed, 53 insertions(+), 49 deletions(-) diff --git a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneMacros.scala b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneMacros.scala index b991c833..dece38ed 100644 --- a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneMacros.scala +++ b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneMacros.scala @@ -8,9 +8,9 @@ import scala.quoted.Varargs import com.raquo.airstream.split.MacrosUtilities.{CaseAny, HandlerAny, MatchTypeHandler, MatchValueHandler, innerObservableImpl} import scala.reflect.TypeTest -/** `SplitMatchOneMacros` turns this code +/** `SplitMatchOneMacros` turns this code: * - * ```scala + * {{{ * sealed trait Foo * final case class Bar(strOpt: Option[String]) extends Foo * enum Baz extends Foo { @@ -30,11 +30,11 @@ import scala.reflect.TypeTest * case _: Int => () * } { (_, _) => div("Taz") } * .toSignal - * ``` + * }}} * * into this code: * - * ```scala + * {{{ * val splitter = fooSignal * .map { i => * i match { @@ -45,7 +45,7 @@ import scala.reflect.TypeTest * } * } * .splitOne(_._1) { ??? } - * ``` + * }}} * * After macros expansion, compiler will warns above code "match may not be * exhaustive" and "unreachable case" as expected. diff --git a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneTypeObservable.scala b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneTypeObservable.scala index 49b9f1ff..d1c7dee8 100644 --- a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneTypeObservable.scala +++ b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneTypeObservable.scala @@ -5,26 +5,26 @@ import scala.annotation.compileTimeOnly import com.raquo.airstream.split.MacrosUtilities.{CaseAny, HandlerAny, MatchTypeHandler} /** `MatchTypeObservable` served as macro's data holder for macro expansion. - * - * For example: - * - * ```scala - * fooSignal.splitMatchOne - * .handleType[Baz] { (baz, bazSignal) => renderBazNode(baz, bazSignal) } - * ``` - * - * will be expanded sematically into: - * - * ```scala - * MatchTypeObservable.build[*, *, *, Baz](fooSignal)()(???)({ case t: Baz => t }) - * ``` - * - * and then into: - * - * ```scala - * MatchSplitObservable.build(fooSignal)({ case baz: Baz => baz })(???) - * ``` - */ + * + * For example: + * + * {{{ + * fooSignal.splitMatchOne + * .handleType[Baz] { (baz, bazSignal) => renderBazNode(baz, bazSignal) } + * }}} + * + * will be expanded sematically into: + * + * {{{ + * MatchTypeObservable.build[*, *, *, Baz](fooSignal)()(???)({ case t: Baz => t }) + * }}} + * + * and then into: + * + * {{{ + * MatchSplitObservable.build(fooSignal)({ case baz: Baz => baz })(???) + * }}} + */ final case class SplitMatchOneTypeObservable[Self[+_] <: Observable[_], I, O, T] private (private val underlying: Unit) extends AnyVal diff --git a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneValueObservable.scala b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneValueObservable.scala index 2cae7a33..9c50305e 100644 --- a/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneValueObservable.scala +++ b/src/main/scala-3/com/raquo/airstream/split/SplitMatchOneValueObservable.scala @@ -5,26 +5,26 @@ import scala.annotation.compileTimeOnly import com.raquo.airstream.split.MacrosUtilities.{CaseAny, HandlerAny, MatchValueHandler} /** `MatchSingletonObservable` served as macro's data holder for macro expansion. - * - * For example: - * - * ```scala - * fooSignal.splitMatchOne - * .splitValue(Tar)(tarSignal => renderTarNode(tarSignal)) - * ``` - * - * will be expanded sematically into: - * - * ```scala - * MatchTypeObservable.build[*, *, *, Baz](fooSignal)()(???)({ case Tar => Tar }) - * ``` - * - * and then into: - * - * ```scala - * MatchSplitObservable.build(fooSignal)({ case Tar => Tar })(???) - * ``` - */ + * + * For example: + * + * {{{ + * fooSignal.splitMatchOne + * .splitValue(Tar)(tarSignal => renderTarNode(tarSignal)) + * }}} + * + * will be expanded sematically into: + * + * {{{ + * MatchTypeObservable.build[*, *, *, Baz](fooSignal)()(???)({ case Tar => Tar }) + * }}} + * + * and then into: + * + * {{{ + * MatchSplitObservable.build(fooSignal)({ case Tar => Tar })(???) + * }}} + */ final case class SplitMatchOneValueObservable[Self[+_] <: Observable[_], I, O, V] private (private val underlying: Unit) extends AnyVal diff --git a/src/main/scala/com/raquo/airstream/debug/DebuggableObservable.scala b/src/main/scala/com/raquo/airstream/debug/DebuggableObservable.scala index f3442f0e..b9bcd387 100644 --- a/src/main/scala/com/raquo/airstream/debug/DebuggableObservable.scala +++ b/src/main/scala/com/raquo/airstream/debug/DebuggableObservable.scala @@ -9,7 +9,9 @@ import scala.util.{Failure, Success, Try} /** This implicit class provides debug* methods for observables, e.g.: * - * stream.debugWithName("MyStream").debugSpyStarts().debugLogEvents() + * {{{ + * stream.debugWithName("MyStream").debugSpyStarts().debugLogEvents() + * }}} * * The result of the chain is an observable that you should use in place * of the original observable (`stream` in this case). diff --git a/src/main/scala/com/raquo/airstream/debug/DebuggableSignal.scala b/src/main/scala/com/raquo/airstream/debug/DebuggableSignal.scala index 33f0b3af..e8db1bfc 100644 --- a/src/main/scala/com/raquo/airstream/debug/DebuggableSignal.scala +++ b/src/main/scala/com/raquo/airstream/debug/DebuggableSignal.scala @@ -8,7 +8,9 @@ import scala.util.{Failure, Success, Try} /** This implicit class provides Signal-specific debug* methods, e.g.: * - * signal.debugLogInitialEval().debugLog() + * {{{ + * signal.debugLogInitialEval().debugLog() + * }}} * * See [[DebuggableObservable]] and the docs for details. * diff --git a/src/main/scala/com/raquo/airstream/misc/DropStream.scala b/src/main/scala/com/raquo/airstream/misc/DropStream.scala index 4a3ee05b..57fbe4e4 100644 --- a/src/main/scala/com/raquo/airstream/misc/DropStream.scala +++ b/src/main/scala/com/raquo/airstream/misc/DropStream.scala @@ -9,7 +9,7 @@ import com.raquo.airstream.core.{EventStream, Protected, Transaction} * * Note: only events are dropped, not errors. * - * @param dropWhile nextEvent => shouldDrop + * @param dropWhile `nextEvent => shouldDrop` * Function which determines whether this stream should drop the given event. * Warning: MUST NOT THROW! * diff --git a/src/main/scala/com/raquo/airstream/timing/PeriodicStream.scala b/src/main/scala/com/raquo/airstream/timing/PeriodicStream.scala index 5f2bf33c..6064dfcd 100644 --- a/src/main/scala/com/raquo/airstream/timing/PeriodicStream.scala +++ b/src/main/scala/com/raquo/airstream/timing/PeriodicStream.scala @@ -7,7 +7,7 @@ import scala.util.{Failure, Success, Try} // #TODO[API] Since this has an initial value, should this be a signal perhaps? -/** @param next (currentState => (nextState, nextIntervalMs) +/** @param next `(currentState => (nextState, nextIntervalMs)` * Note: guarded against exceptions. * If `next` throws, stream will emit that error */