Skip to content

Commit 2010a93

Browse files
committed
Move name filtering to AST build in Phase.scala
1 parent cb4d93c commit 2010a93

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

dottydoc/jvm/src/dotty/tools/dottydoc/core/Phases.scala

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,30 +59,31 @@ object Phases {
5959

6060
/** trait */
6161
case t @ TypeDef(n, rhs) if t.symbol.is(Flags.Trait) =>
62-
val name = n.toString
62+
val name = filteredName(n.toString)
6363
val newPath = prev :+ name
6464
TraitImpl(name, collectMembers(rhs), flags(t), newPath)
6565

6666
/** objects, on the format "Object$" so drop the last letter */
6767
case o @ TypeDef(n, rhs) if o.symbol.is(Flags.Module) =>
68-
val name = n.toString.dropRight(1)
68+
val name = filteredName(n.toString.dropRight(1))
6969
ObjectImpl(name, collectMembers(rhs, prev :+ name), flags(o), prev :+ (name + "$"))
7070

7171
/** class / case class */
72-
case c @ TypeDef(name, rhs) if c.symbol.isClass =>
73-
val newPath = prev :+ name.toString
74-
(name.toString, collectMembers(rhs), flags(c), newPath, None) match {
72+
case c @ TypeDef(n, rhs) if c.symbol.isClass =>
73+
val name = filteredName(n.toString)
74+
val newPath = prev :+ name
75+
(name, collectMembers(rhs), flags(c), newPath, None) match {
7576
case x if c.symbol.is(Flags.CaseClass) => CaseClassImpl.tupled(x)
7677
case x => ClassImpl.tupled(x)
7778
}
7879

7980
/** def */
8081
case d: DefDef =>
81-
DefImpl(d.name.toString, flags(d), path(d), returnType(d.tpt))
82+
DefImpl(filteredName(d.name.toString), flags(d), path(d), returnType(d.tpt))
8283

8384
/** val */
8485
case v: ValDef if !v.symbol.is(Flags.ModuleVal) =>
85-
ValImpl(v.name.toString, flags(v), path(v), returnType(v.tpt))
86+
ValImpl(filteredName(v.name.toString), flags(v), path(v), returnType(v.tpt))
8687

8788
case x => {
8889
//dottydoc.println(s"Found unwanted entity: $x (${x.pos},\n${x.show}")

dottydoc/jvm/src/dotty/tools/dottydoc/html/EntityPage.scala

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,6 @@ case class EntityPage(entity: Entity, packages: Map[String, Package]) {
7575
)
7676
)
7777

78-
private def filteredName(str: String) = str
79-
.replaceAll("\\$colon", ":")
80-
.replaceAll("\\$plus", "+")
81-
8278
private def relativePath(to: Entity) =
8379
util.traversing.relativePath(entity, to)
8480

@@ -116,13 +112,13 @@ case class EntityPage(entity: Entity, packages: Map[String, Package]) {
116112
a(
117113
cls := "entity-name",
118114
href := entityUrl,
119-
filteredName(entity.name)
115+
entity.name
120116
)
121117
)
122118
}
123119

124120
if (children.length > 0)
125-
li(cls := "mdl-list__item package", href := relativePath(pack), filteredName(k)) :: children
121+
li(cls := "mdl-list__item package", href := relativePath(pack), k) :: children
126122
else Nil
127123
}
128124
}

dottydoc/shared/src/main/scala/dotty/tools/dottydoc/model/factories.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,8 @@ object factories {
4141
// TODO: should be updated to link to local entities
4242
def returnType(t: Tree)(implicit ctx: Context): String =
4343
t.show
44+
45+
def filteredName(str: String) = str
46+
.replaceAll("\\$colon", ":")
47+
.replaceAll("\\$plus", "+")
4448
}

0 commit comments

Comments
 (0)