Skip to content

Commit 6c92428

Browse files
committed
address feedback on #2074
- Added tests to ensure that the results of serialization match their pre-serialization values. - Removed unused parameter `extras` from Entity.asJava() implicit methods. - Removed _root_ imports - Fixed several code style issues
1 parent e7fe9df commit 6c92428

File tree

2 files changed

+346
-123
lines changed

2 files changed

+346
-123
lines changed

doc-tool/src/dotty/tools/dottydoc/model/JavaConverters.scala

Lines changed: 69 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ package model
44
import comment._
55
import references._
66

7-
import _root_.java.util.LinkedList
7+
import java.util.LinkedList
88

99
object JavaConverters {
1010
import scala.collection.JavaConverters._
11-
import _root_.java.util.{ Map => JMap }
11+
import java.util.{ Map => JMap }
1212

1313
implicit class OptStr(val opt: Option[String]) extends AnyVal {
1414
def asJava = opt.getOrElse(null)
@@ -20,56 +20,56 @@ object JavaConverters {
2020

2121
implicit class JavaComment(val cmt: Comment) extends AnyVal {
2222
def asJava: JMap[String, _] = Map(
23-
"body" -> cmt.body,
24-
"short" -> cmt.short,
25-
"authors" -> cmt.authors.asJava,
26-
"see" -> cmt.see.asJava,
27-
"result" -> cmt.result.asJava,
28-
"throws" -> cmt.throws.asJava,
29-
"valueParams" -> cmt.valueParams.asJava,
30-
"typeParams" -> cmt.typeParams.asJava,
31-
"version" -> cmt.version.asJava,
32-
"since" -> cmt.since.asJava,
33-
"todo" -> cmt.todo.asJava,
34-
"deprecated" -> cmt.deprecated.asJava,
35-
"note" -> cmt.note.asJava,
36-
"example" -> cmt.example.asJava,
37-
"constructor" -> cmt.constructor.asJava,
38-
"group" -> cmt.group.asJava,
39-
"groupDesc" -> cmt.groupDesc.asJava,
40-
"groupNames" -> cmt.groupNames.asJava,
41-
"groupPrio" -> cmt.groupPrio.asJava,
23+
"body" -> cmt.body,
24+
"short" -> cmt.short,
25+
"authors" -> cmt.authors.asJava,
26+
"see" -> cmt.see.asJava,
27+
"result" -> cmt.result.asJava,
28+
"throws" -> cmt.throws.asJava,
29+
"valueParams" -> cmt.valueParams.asJava,
30+
"typeParams" -> cmt.typeParams.asJava,
31+
"version" -> cmt.version.asJava,
32+
"since" -> cmt.since.asJava,
33+
"todo" -> cmt.todo.asJava,
34+
"deprecated" -> cmt.deprecated.asJava,
35+
"note" -> cmt.note.asJava,
36+
"example" -> cmt.example.asJava,
37+
"constructor" -> cmt.constructor.asJava,
38+
"group" -> cmt.group.asJava,
39+
"groupDesc" -> cmt.groupDesc.asJava,
40+
"groupNames" -> cmt.groupNames.asJava,
41+
"groupPrio" -> cmt.groupPrio.asJava,
4242
"hideImplicitConversions" -> cmt.hideImplicitConversions.asJava
4343
).asJava
4444
}
4545

4646
implicit class JavaParamList(val pl: ParamList) extends AnyVal {
4747
def asJava: JMap[String, _] = Map(
48-
"list" -> pl.list.map(_.asJava).asJava,
48+
"list" -> pl.list.map(_.asJava).asJava,
4949
"isImplicit" -> pl.isImplicit
5050
).asJava
5151
}
5252

5353
implicit class JavaReference(val ref: Reference) extends AnyVal {
5454
def asJava: JMap[String, _] = ref match {
5555
case TypeReference(title, tpeLink, paramLinks) => Map(
56-
"kind" -> "TypeReference",
57-
"title" -> title,
58-
"tpeLink" -> tpeLink.asJava,
56+
"kind" -> "TypeReference",
57+
"title" -> title,
58+
"tpeLink" -> tpeLink.asJava,
5959
"paramLinks" -> paramLinks.map(_.asJava).asJava,
60-
"scala" -> ref
60+
"scala" -> ref
6161
).asJava
6262

6363
case OrTypeReference(left, right) => Map(
64-
"kind" -> "OrTypeReference",
65-
"left" -> left.asJava,
64+
"kind" -> "OrTypeReference",
65+
"left" -> left.asJava,
6666
"right" -> right.asJava,
6767
"scala" -> ref
6868
).asJava
6969

7070
case AndTypeReference(left, right) => Map(
71-
"kind" -> "AndTypeReference",
72-
"left" -> left.asJava,
71+
"kind" -> "AndTypeReference",
72+
"left" -> left.asJava,
7373
"right" -> right.asJava,
7474
"scala" -> ref
7575
).asJava
@@ -88,23 +88,23 @@ object JavaConverters {
8888
).asJava
8989

9090
case BoundsReference(low, high) => Map(
91-
"kind" -> "BoundsReference",
92-
"low" -> low.asJava,
91+
"kind" -> "BoundsReference",
92+
"low" -> low.asJava,
9393
"hight" -> high.asJava,
9494
"scala" -> ref
9595
).asJava
9696

9797
case NamedReference(title, ref, isByName, isRepeated) => Map(
98-
"kind" -> "NamedReference",
99-
"title" -> title,
100-
"ref" -> ref.asJava,
101-
"isByName" -> isByName,
98+
"kind" -> "NamedReference",
99+
"title" -> title,
100+
"ref" -> ref.asJava,
101+
"isByName" -> isByName,
102102
"isRepeated" -> isRepeated,
103-
"scala" -> ref
103+
"scala" -> ref
104104
).asJava
105105

106106
case ConstantReference(title) => Map(
107-
"kind" -> "ConstantReference",
107+
"kind" -> "ConstantReference",
108108
"title" -> title,
109109
"scala" -> ref
110110
).asJava
@@ -117,46 +117,46 @@ object JavaConverters {
117117
implicit class JavaMaterializableLink(val link: MaterializableLink) extends AnyVal {
118118
def asJava: JMap[String, _] = link match {
119119
case UnsetLink(title, query) => Map(
120-
"kind" -> "UnsetLink",
120+
"kind" -> "UnsetLink",
121121
"title" -> title,
122122
"query" -> query,
123123
"scala" -> link
124124
).asJava
125125

126126
case MaterializedLink(title, target) => Map(
127-
"kind" -> "MaterializedLink",
128-
"title" -> title,
127+
"kind" -> "MaterializedLink",
128+
"title" -> title,
129129
"target" -> target,
130130
"scala" -> link
131131
).asJava
132132

133133
case NoLink(title, target) => Map(
134-
"kind" -> "NoLink",
135-
"title" -> title,
134+
"kind" -> "NoLink",
135+
"title" -> title,
136136
"target" -> target,
137137
"scala" -> link
138138
).asJava
139139
}
140140
}
141141

142142
implicit class JavaEntity(val ent: Entity) extends AnyVal {
143-
def asJava(extras: Map[String, _] = Map.empty): JMap[String, _] = parseEntity(ent, extras)
143+
def asJava(): JMap[String, _] = parseEntity(ent)
144144
}
145145

146-
private def parseEntity(ent: Entity, extras: Map[String, _]): JMap[String, _] = {
146+
private def parseEntity(ent: Entity): JMap[String, _] = {
147147
val entity = Map(
148-
"kind" -> ent.kind,
148+
"kind" -> ent.kind,
149149
"annotations" -> ent.annotations.asJava,
150-
"name" -> ent.name,
151-
"path" -> ent.path.asJava,
152-
"children" -> ent.children.map(_.asJava()).asJava,
153-
"comment" -> ent.comment.map(_.asJava).asJava,
150+
"name" -> ent.name,
151+
"path" -> ent.path.asJava,
152+
"children" -> ent.children.map(_.asJava()).asJava,
153+
"comment" -> ent.comment.map(_.asJava).asJava,
154154
"hasShortenedDocstring" -> ent.hasShortenedDocstring,
155155
"signature" -> ent.signature
156156
)
157157
val members = ent match {
158158
case ent: Members => Map(
159-
"members" -> ent.members.map(_.asJava()).asJava,
159+
"members" -> ent.members.map(_.asJava()).asJava,
160160
"hasVisibleMembers" -> ent.hasVisibleMembers
161161
)
162162
case _ => Map.empty
@@ -196,7 +196,7 @@ object JavaConverters {
196196
}
197197
val returnValue = ent match {
198198
case ent: ReturnValue => Map(
199-
"returnValue" -> ent.returnValue.asJava
199+
"returnValue" -> ent.returnValue.asJava
200200
)
201201
case _ => Map.empty
202202
}
@@ -214,17 +214,31 @@ object JavaConverters {
214214
}
215215
val trt = ent match {
216216
case ent: Trait => Map(
217-
"traitParams" -> ent.traitParams.map(_.asJava).asJava
217+
"traitParams" -> ent.traitParams.map(_.asJava).asJava
218218
)
219219
case _ => Map.empty
220220
}
221221
val df = ent match {
222222
case ent: Def => Map(
223-
"paramLists" -> ent.paramLists.map(_.asJava).asJava
223+
"paramLists" -> ent.paramLists.map(_.asJava).asJava
224224
)
225225
case _ => Map.empty
226226
}
227-
(entity ++ members ++ superTypes ++ modifiers ++ typeParams ++ constructors ++ companion ++ returnValue ++ implicitlyAddedEntity ++ typeAlias ++ trt ++ df).asJava
227+
228+
{
229+
entity ++
230+
members ++
231+
superTypes ++
232+
modifiers ++
233+
typeParams ++
234+
constructors ++
235+
companion ++
236+
returnValue ++
237+
implicitlyAddedEntity ++
238+
typeAlias ++
239+
trt ++
240+
df
241+
}.asJava
228242
}
229243

230244
implicit class JavaMap(val map: collection.Map[String, Package]) extends AnyVal {

0 commit comments

Comments
 (0)