Skip to content

Commit e7959c2

Browse files
committed
Uniformize api's Parameter case classes
1 parent 5d34fba commit e7959c2

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

scaladoc/src/dotty/tools/scaladoc/api.scala

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,24 @@ enum Modifier(val name: String, val prefix: Boolean):
4444
case Transparent extends Modifier("transparent", true)
4545
case Infix extends Modifier("infix", true)
4646

47-
case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList], signature: Signature, dri: DRI, position: Long)
47+
case class ExtensionTarget(name: String, typeParams: Seq[TypeParameter], argsLists: Seq[TermParameterList], signature: Signature, dri: DRI, position: Long)
4848
case class ImplicitConversion(from: DRI, to: DRI)
4949
trait ImplicitConversionProvider { def conversion: Option[ImplicitConversion] }
5050
trait Classlike:
5151
def typeParams: Seq[TypeParameter] = Seq.empty
52-
def argsLists: Seq[ParametersList] = Seq.empty
52+
def argsLists: Seq[TermParameterList] = Seq.empty
5353

5454
enum Kind(val name: String):
5555
case RootPackage extends Kind("")
5656
case Package extends Kind("package")
57-
case Class(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[ParametersList])
57+
case Class(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[TermParameterList])
5858
extends Kind("class") with Classlike
5959
case Object extends Kind("object") with Classlike
60-
case Trait(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[ParametersList])
60+
case Trait(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[TermParameterList])
6161
extends Kind("trait") with Classlike
62-
case Enum(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[ParametersList]) extends Kind("enum") with Classlike
62+
case Enum(override val typeParams: Seq[TypeParameter], override val argsLists: Seq[TermParameterList]) extends Kind("enum") with Classlike
6363
case EnumCase(kind: Object.type | Kind.Type | Val.type | Class) extends Kind("case")
64-
case Def(typeParams: Seq[TypeParameter], argsLists: Seq[ParametersList])
64+
case Def(typeParams: Seq[TypeParameter], argsLists: Seq[TermParameterList])
6565
extends Kind("def")
6666
case Extension(on: ExtensionTarget, m: Kind.Def) extends Kind("def")
6767
case Constructor(base: Kind.Def) extends Kind("def")
@@ -97,12 +97,12 @@ object Annotation:
9797
case class LinkParameter(name: Option[String] = None, dri: DRI, value: String) extends AnnotationParameter
9898
case class UnresolvedParameter(name: Option[String] = None, unresolvedText: String) extends AnnotationParameter
9999

100-
case class ParametersList(
101-
parameters: Seq[Parameter],
100+
case class TermParameterList(
101+
parameters: Seq[TermParameter],
102102
modifiers: String
103103
)
104104

105-
case class Parameter(
105+
case class TermParameter(
106106
annotations: Seq[Annotation],
107107
modifiers: String,
108108
name: Option[String],
@@ -112,6 +112,8 @@ case class Parameter(
112112
isGrouped: Boolean = false
113113
)
114114

115+
type TypeParameterList = Seq[TypeParameter]
116+
115117
case class TypeParameter(
116118
annotations: Seq[Annotation],
117119
variance: "" | "+" | "-",

scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ trait ClassLikeSupport:
4545
.filter(s => s.exists && !s.isHiddenByVisibility)
4646
.map( _.tree.asInstanceOf[DefDef])
4747
constr.fold(Nil)(
48-
_.termParamss.map(pList => ParametersList(pList.params.map(p => mkParameter(p, parameterModifier)), paramListModifier(pList.params)))
48+
_.termParamss.map(pList => TermParameterList(pList.params.map(p => mkParameter(p, parameterModifier)), paramListModifier(pList.params)))
4949
)
5050

5151
if classDef.symbol.flags.is(Flags.Module) then Kind.Object
@@ -145,7 +145,7 @@ trait ClassLikeSupport:
145145
memberInfo.paramLists(index) match
146146
case EvidenceOnlyParameterList => Nil
147147
case info: RegularParameterList =>
148-
Seq(ParametersList(paramList.params.map(mkParameter(_, memberInfo = info)), paramListModifier(paramList.params)))
148+
Seq(TermParameterList(paramList.params.map(mkParameter(_, memberInfo = info)), paramListModifier(paramList.params)))
149149
}
150150
val target = ExtensionTarget(
151151
extSym.symbol.normalizedName,
@@ -349,7 +349,7 @@ trait ClassLikeSupport:
349349
memberInfo.paramLists(index) match
350350
case EvidenceOnlyParameterList => Nil
351351
case info: RegularParameterList =>
352-
Seq(ParametersList(pList.params.map(
352+
Seq(TermParameterList(pList.params.map(
353353
mkParameter(_, paramPrefix, memberInfo = info)), paramListModifier(pList.params)
354354
))
355355
}
@@ -393,7 +393,7 @@ trait ClassLikeSupport:
393393
val inlinePrefix = if argument.symbol.flags.is(Flags.Inline) then "inline " else ""
394394
val nameIfNotSynthetic = Option.when(!argument.symbol.flags.is(Flags.Synthetic))(argument.symbol.normalizedName)
395395
val name = argument.symbol.normalizedName
396-
Parameter(
396+
TermParameter(
397397
argument.symbol.getAnnotations(),
398398
inlinePrefix + prefix(argument.symbol),
399399
nameIfNotSynthetic,

scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureUtils.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ case class SignatureBuilder(content: Signature = Nil) extends ScalaSignatureUtil
2626
def annotationsBlock(d: Member): SignatureBuilder =
2727
d.annotations.foldLeft(this){ (bdr, annotation) => bdr.buildAnnotation(annotation)}
2828

29-
def annotationsInline(d: Parameter): SignatureBuilder =
29+
def annotationsInline(d: TermParameter): SignatureBuilder =
3030
d.annotations.foldLeft(this){ (bdr, annotation) => bdr.buildAnnotation(annotation) }
3131

3232
def annotationsInline(t: TypeParameter): SignatureBuilder =
@@ -78,7 +78,7 @@ case class SignatureBuilder(content: Signature = Nil) extends ScalaSignatureUtil
7878
bdr.annotationsInline(e).keyword(e.variance).tpe(e.name, Some(e.dri)).signature(e.signature)
7979
}
8080

81-
def functionParameters(params: Seq[ParametersList]) =
81+
def functionParameters(params: Seq[TermParameterList]) =
8282
if params.isEmpty then this.plain("")
8383
else if params.size == 1 && params(0).parameters == Nil then this.plain("()")
8484
else this.list(params, separator = List(Plain(""))) { (bld, pList) =>

0 commit comments

Comments
 (0)