Skip to content

Commit c5c5c04

Browse files
authored
Merge pull request #48 from halotukozak/update-docs
docs: fix stale scaladoc references
2 parents 444e3e8 + 96ea10d commit c5c5c04

4 files changed

Lines changed: 21 additions & 18 deletions

File tree

made/Done.scala

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import scala.quoted.*
2424
* // done type members:
2525
* // type Type = Service
2626
* // type Label = "Service"
27-
* // type Metadata = Meta
27+
* // type Metadata = EmptyTuple
2828
* // type Operations = DoneOperation { ... "ping" ... } *: DoneOperation { ... "version" ... } *: EmptyTuple
2929
* }}}
3030
*
@@ -40,9 +40,9 @@ sealed trait Done:
4040
type Label <: String
4141

4242
/**
43-
* Annotation metadata on `T`, represented as an `AnnotatedType` chain wrapping the [[Meta]]
44-
* base type. When no `MetaAnnotation` annotations are present, `Metadata = Meta`. When
45-
* annotations are present, `Metadata` becomes `Meta @Ann1 @Ann2 ...`.
43+
* Annotation metadata on `T`, represented as a [[Tuple]] of `Meta @ann` entries. When no
44+
* `MetaAnnotation` annotations are present, `Metadata = EmptyTuple`. When annotations are
45+
* present, `Metadata` becomes `(Meta @Ann1, Meta @Ann2, ...)`.
4646
*/
4747
type Metadata <: Tuple
4848

@@ -74,8 +74,8 @@ sealed trait DoneOperation:
7474
type Label <: String
7575

7676
/**
77-
* Annotation metadata on the member, represented as an `AnnotatedType` chain wrapping
78-
* the [[Meta]] base type.
77+
* Annotation metadata on the member, represented as a [[Tuple]] of `Meta @ann` entries.
78+
* `EmptyTuple` when no `MetaAnnotation` annotations are present.
7979
*/
8080
type Metadata <: Tuple
8181

@@ -151,8 +151,9 @@ sealed trait InputElem:
151151
type Label <: String
152152

153153
/**
154-
* Annotation metadata on the parameter, represented as an `AnnotatedType` chain wrapping
155-
* the [[Meta]] base type.
154+
* Annotation metadata on the parameter, represented as a [[Tuple]] of `Meta @ann` entries.
155+
* `EmptyTuple` when no `MetaAnnotation` annotations are present. Currently always
156+
* `EmptyTuple` — parameter annotations are not yet captured by [[Done.derived]].
156157
*/
157158
type Metadata <: Tuple
158159

made/Made.scala

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ import scala.quoted.*
2020
*
2121
* case class User(name: String, age: Int)
2222
*
23-
* val mirror: Made.Of[User] = Made.derived[User]
23+
* val mirror = Made.derived[User]
2424
* // mirror type members:
2525
* // type Type = User
2626
* // type Label = "User"
27-
* // type Metadata = Meta
27+
* // type Metadata = EmptyTuple
2828
* // type Elems = MadeFieldElem { ... } *: MadeFieldElem { ... } *: EmptyTuple
2929
*
30-
* val (nameFld, ageFld) = mirror.mirroredElems
30+
* val (nameFld, ageFld) = mirror.elems
3131
* val user = mirror.fromUnsafeArray(Array("Alice", 30))
3232
* }}}
3333
*
@@ -618,8 +618,8 @@ object Made:
618618
* Produced by [[Made.derived]] when `T` is a case class, a zero-field
619619
* case class, or a value class (extends `AnyVal`).
620620
*
621-
* [[Made.Elems]] is a tuple of [[MadeFieldElem]] representing each
622-
* constructor parameter. [[Made.GeneratedElem]] is a tuple of
621+
* [[Elems]] is a tuple of [[MadeFieldElem]] representing each
622+
* constructor parameter. [[GeneratedElems]] is a tuple of
623623
* [[GeneratedMadeElem]] for any `@generated` members.
624624
*
625625
* @see [[Made]]

made/extensions.scala

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,14 @@ extension [Ls <: Tuple](l: { type ElemLabels = Ls })
3636

3737
extension (es: Tuple)(using es.type containsOnly { type Metadata <: Tuple })
3838
/**
39-
* Per-element [[hasAnnotation]] over a tuple of [[MadeElem]]s.
39+
* Per-element [[hasAnnotation]] over a tuple whose entries each declare a `Metadata` type member
40+
* (e.g. a tuple of [[MadeElem]]s, [[GeneratedMadeElem]]s, or a singleton `Made` instance's
41+
* `Metadata` chain).
4042
*/
4143
transparent inline def hasAnnotations[A <: Annotation]: Tuple = ${ hasAnnotationsImpl[es.type, A] }
4244

4345
/**
44-
* Per-element [[getAnnotation]] over a tuple of [[MadeElem]]s.
46+
* Per-element [[getAnnotation]] over a tuple whose entries each declare a `Metadata` type member.
4547
*/
4648
transparent inline def getAnnotations[A <: Annotation]: Tuple = ${ getAnnotationsImpl[es.type, A] }
4749

made/package.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
* Derive a mirror with `Made.derived[T]`. The resulting mirror subtype depends on `T`:
66
* singletons, transparent wrappers, products (case classes), or sums (sealed traits/enums).
77
*
8-
* Each mirror carries a `MirroredElems` tuple of [[made.MadeElem]] subtypes describing
9-
* constructor fields or sum subtypes, and a `Metadata` type member encoding
10-
* annotations as an `AnnotatedType` chain around [[made.Meta]].
8+
* Each mirror carries an `Elems` tuple of [[made.MadeElem]] subtypes describing
9+
* constructor fields or sum subtypes, and a `Metadata` tuple of `Meta @ann` entries
10+
* encoding annotations applied to the mirrored type.
1111
*
1212
* @see [[made.Made]]
1313
* @see [[made.MadeElem]]

0 commit comments

Comments
 (0)