blob: 55f2a05babcddb74157e6765595147a42ce6496f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
package dotty.tools
package dottydoc
package core
import dotc.core.Contexts.Context
import dotc.core.Symbols.Symbol
import dotc.core.Comments.{ Comment => CompilerComment }
import transform.DocMiniPhase
import model._
import model.internal._
import model.comment._
import HtmlParsers._
import util.syntax._
/** Phase to add docstrings to the Dottydoc AST */
class DocstringPhase extends DocMiniPhase with CommentParser with CommentCleaner {
private def getComment(sym: Symbol)(implicit ctx: Context): Option[CompilerComment] =
ctx.docbase.docstring(sym)
.orElse {
// If the symbol doesn't have a docstring, look for an overridden
// ancestor with a docstring
sym.allOverriddenSymbols.collectFirst {
case parentSym if ctx.docbase.docstring(parentSym).isDefined =>
parentSym
}
.flatMap(ctx.docbase.docstring)
}
private def parsedComment(ent: Entity)(implicit ctx: Context): Option[Comment] =
getComment(ent.symbol).map { cmt =>
val parsed = parse(ent, ctx.docbase.packages, clean(cmt.raw), cmt.raw, cmt.pos)
if (ctx.settings.wikiSyntax.value)
WikiComment(ent, parsed, cmt.pos).comment
else
MarkdownComment(ent, parsed, cmt.pos).comment
}
override def transformPackage(implicit ctx: Context) = { case ent: PackageImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformClass(implicit ctx: Context) = { case ent: ClassImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformCaseClass(implicit ctx: Context) = { case ent: CaseClassImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformTrait(implicit ctx: Context) = { case ent: TraitImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformObject(implicit ctx: Context) = { case ent: ObjectImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformDef(implicit ctx: Context) = { case ent: DefImpl =>
ent.copy(comment = parsedComment(ent))
}
override def transformVal(implicit ctx: Context) = { case ent: ValImpl =>
ent.copy(comment = parsedComment(ent))
}
}
|
