diff options
| author | Jon Pretty <jon.pretty@propensive.com> | 2017-11-09 09:24:18 +0000 |
|---|---|---|
| committer | Jon Pretty <jon.pretty@propensive.com> | 2017-11-09 09:24:18 +0000 |
| commit | e396b7a038e458de37ced6b59e0d367883bc3b71 (patch) | |
| tree | fcdcf1950d34f5ec88ce2b6239d1ce51bb49fd94 | |
| parent | c5c9c4f1432391f6af9202dd89872e5aae92ca58 (diff) | |
| download | magnolia-e396b7a038e458de37ced6b59e0d367883bc3b71.tar.gz magnolia-e396b7a038e458de37ced6b59e0d367883bc3b71.tar.bz2 magnolia-e396b7a038e458de37ced6b59e0d367883bc3b71.zip | |
Scaladoc corrections
| -rw-r--r-- | core/src/main/scala/interface.scala | 7 | ||||
| -rw-r--r-- | examples/src/main/scala/decode.scala | 2 | ||||
| -rw-r--r-- | examples/src/main/scala/show.scala | 4 |
3 files changed, 7 insertions, 6 deletions
diff --git a/core/src/main/scala/interface.scala b/core/src/main/scala/interface.scala index ed5fa37..ecc4379 100644 --- a/core/src/main/scala/interface.scala +++ b/core/src/main/scala/interface.scala @@ -39,7 +39,8 @@ trait Param[Typeclass[_], Type] { * case class Person(name: String, age: Int) * </pre> * the [[Param]] instance corresponding to the `age` parameter would have a [[PType]] equal to - * the type [[Int]]. However, in practice, this type will never be universally quantified. */ + * the type [[scala.Int]]. However, in practice, this type will never be universally quantified. + */ type PType /** the name of the parameter */ @@ -112,8 +113,8 @@ abstract class CaseClass[Typeclass[_], Type] private[magnolia]( /** a sequence of [[Param]] objects representing all of the parameters in the case class * - * For efficiency, this sequence is implemented by an `Array`, but upcast to a [[Seq]] to hide - * the mutable collection API. */ + * For efficiency, this sequence is implemented by an `Array`, but upcast to a + * [[scala.collection.Seq]] to hide the mutable collection API. */ def parameters: Seq[Param[Typeclass, Type]] = parametersArray } diff --git a/examples/src/main/scala/decode.scala b/examples/src/main/scala/decode.scala index eca56d2..8603b9e 100644 --- a/examples/src/main/scala/decode.scala +++ b/examples/src/main/scala/decode.scala @@ -9,7 +9,7 @@ import scala.language.experimental.macros /** very basic decoder for converting strings to other types */ trait Decoder[T] { def decode(str: String): T } -/** derivation object (and companion object) for [[Derivation]] instances */ +/** derivation object (and companion object) for [[Decoder]] instances */ object Decoder { /** decodes strings */ diff --git a/examples/src/main/scala/show.scala b/examples/src/main/scala/show.scala index 9da507c..860871e 100644 --- a/examples/src/main/scala/show.scala +++ b/examples/src/main/scala/show.scala @@ -9,7 +9,7 @@ import scala.language.experimental.macros /** shows one type as another, often as a string * * Note that this is a more general form of `Show` than is usual, as it permits the return type to - * be something other than [[String]]. */ + * be something other than a string. */ trait Show[Out, T] { def show(value: T): Out } /** companion object to [[Show]] */ @@ -17,7 +17,7 @@ object Show { /** the type constructor for new [[Show]] instances * - * The first parameter is fixed as [[String]], and the second parameter varies generically. */ + * The first parameter is fixed as `String`, and the second parameter varies generically. */ type Typeclass[T] = Show[String, T] /** creates a new [[Show]] instance by labelling and joining (with `mkString`) the result of |