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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
package dotty.tools
package dottydoc
package model
package comment
import dotty.tools.dottydoc.util.syntax._
import dotty.tools.dotc.core.Contexts.Context
import dotty.tools.dotc.util.Positions.Position
import dotty.tools.dotc.config.Printers.dottydoc
case class Comment (
body: String,
short: String,
authors: List[String],
see: List[String],
result: Option[String],
throws: Map[String, String],
valueParams: Map[String, String],
typeParams: Map[String, String],
version: Option[String],
since: Option[String],
todo: List[String],
deprecated: Option[String],
note: List[String],
example: List[String],
constructor: Option[String],
group: Option[String],
groupDesc: Map[String, String],
groupNames: Map[String, String],
groupPrio: Map[String, String],
/** List of conversions to hide - containing e.g: `scala.Predef.FloatArrayOps` */
hideImplicitConversions: List[String]
)
private[comment] case class ParsedComment (
body: String,
authors: List[String],
see: List[String],
result: List[String],
throws: Map[String, String],
valueParams: Map[String, String],
typeParams: Map[String, String],
version: List[String],
since: List[String],
todo: List[String],
deprecated: List[String],
note: List[String],
example: List[String],
constructor: List[String],
group: List[String],
groupDesc: Map[String, String],
groupNames: Map[String, String],
groupPrio: Map[String, String],
hideImplicitConversions: List[String],
shortDescription: List[String]
)
object MarkdownComment extends util.MemberLookup {
import HtmlParsers._
def apply(parsed: ParsedComment, ent: Entity)(implicit ctx: Context): Comment = {
val inlineToHtml = InlineToHtml(ent)
def linkedExceptions(m: Map[String, String]): Map[String, String] = {
m.map { case (targetStr, body) =>
val link = lookup(ent, ctx.docbase.packages, targetStr)
val entityLink = EntityLink(Monospace(Text(targetStr)), link)
(targetStr, inlineToHtml(entityLink))
}
}
Comment(
body = parsed.body.toMarkdownString(ent),
short = parsed.body.toMarkdown(ent).shortenAndShow,
authors = filterEmpty(parsed.authors).map(_.toMarkdownString(ent)),
see = filterEmpty(parsed.see).map(_.toMarkdownString(ent)),
result = single("@result", parsed.result).map(_.toMarkdownString(ent)),
throws = linkedExceptions(parsed.throws).mapValues(_.toMarkdownString(ent)),
valueParams = filterEmpty(parsed.valueParams).mapValues(_.toMarkdownString(ent)),
typeParams = filterEmpty(parsed.typeParams).mapValues(_.toMarkdownString(ent)),
version = single("@version", parsed.version).map(_.toMarkdownString(ent)),
since = single("@since", parsed.since).map(_.toMarkdownString(ent)),
todo = filterEmpty(parsed.todo).map(_.toMarkdownString(ent)),
deprecated = single("@deprecated", parsed.deprecated, filter = false).map(_.toMarkdownString(ent)),
note = filterEmpty(parsed.note).map(_.toMarkdownString(ent)),
example = filterEmpty(parsed.example).map(_.toMarkdownString(ent)),
constructor = single("@constructor", parsed.constructor).map(_.toMarkdownString(ent)),
group = single("@group", parsed.group).map(_.toMarkdownString(ent)),
groupDesc = filterEmpty(parsed.groupDesc).mapValues(_.toMarkdownString(ent)),
groupNames = filterEmpty(parsed.groupNames).mapValues(_.toMarkdownString(ent)),
groupPrio = filterEmpty(parsed.groupPrio).mapValues(_.toMarkdownString(ent)),
hideImplicitConversions = filterEmpty(parsed.hideImplicitConversions).map(_.toMarkdownString(ent))
)
}
private def filterEmpty(xs: List[String]) =
xs.map(_.trim).filterNot(_.isEmpty)
private def filterEmpty(xs: Map[String, String]) =
xs.mapValues(_.trim).filterNot { case (_, v) => v.isEmpty }
private def single(annot: String, xs: List[String], filter: Boolean = true): Option[String] =
(if (filter) filterEmpty(xs) else xs) match {
case x :: xs =>
if (xs.nonEmpty) dottydoc.println(s"Only allowed to have a single annotation for $annot")
Some(x)
case _ => None
}
}
object WikiComment extends util.MemberLookup {
import HtmlParsers._
def apply(parsed: ParsedComment, ent: Entity, pos: Position)(implicit ctx: Context): Comment = {
val inlineToHtml = InlineToHtml(ent)
val packages = ctx.docbase.packages
val parsedBody = parsed.body.toWiki(ent, packages, pos).show(ent)
def linkedExceptions(m: Map[String, Body]): Map[String, Body] = {
m.map { case (targetStr, body) =>
val link = lookup(ent, ctx.docbase.packages, targetStr)
val newBody = body match {
case Body(List(Paragraph(Chain(content)))) =>
val descr = Text(" ") +: content
val entityLink = EntityLink(Monospace(Text(targetStr)), link)
Body(List(Paragraph(Chain(entityLink +: descr))))
case _ => body
}
(targetStr, newBody)
}
}
def toWiki(str: String): Body = str.toWiki(ent, packages, pos)
def toString(body: Body): String = body.show(ent)
def filterEmpty(xs: List[String]): List[Body] =
xs.map(toWiki).filterNot(_.blocks.isEmpty)
def filterEmptyMap(xs: Map[String, String]): Map[String, Body] =
xs.mapValues(toWiki).filterNot { case (_, v) => v.blocks.isEmpty }
def single(annot: String, xs: List[String], filter: Boolean = false): Option[String] = {
val head = (if (filter) filterEmpty(xs) else xs.map(toWiki)) match {
case x :: xs =>
if (xs.nonEmpty) dottydoc.println(s"Only allowed to have a single annotation for $annot")
Some(x)
case _ => None
}
head.map(toString)
}
Comment(
body = parsedBody,
short = parsedBody,
authors = filterEmpty(parsed.authors).map(toString),
see = filterEmpty(parsed.see).map(toString),
result = single("@result", parsed.result),
throws = linkedExceptions(parsed.throws.mapValues(toWiki)).mapValues(toString),
valueParams = filterEmptyMap(parsed.valueParams).mapValues(toString),
typeParams = filterEmptyMap(parsed.typeParams).mapValues(toString),
version = single("@version", parsed.version),
since = single("@since", parsed.since),
todo = filterEmpty(parsed.todo).map(toString),
deprecated = single("@deprecated", parsed.deprecated, filter = false),
note = filterEmpty(parsed.note).map(toString),
example = filterEmpty(parsed.example).map(toString),
constructor = single("@constructor", parsed.constructor),
group = single("@group", parsed.group),
groupDesc = filterEmptyMap(parsed.groupDesc).mapValues(toString),
groupNames = filterEmptyMap(parsed.groupNames).mapValues(toString),
groupPrio = filterEmptyMap(parsed.groupPrio).mapValues(toString),
hideImplicitConversions = filterEmpty(parsed.hideImplicitConversions).map(toString)
)
}
}
|
