Skip to content

Commit 11eea8c

Browse files
committed
Add package documentation from package objects
1 parent 00a9d35 commit 11eea8c

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,8 @@ extension[T] (member: Member)
195195

196196
def withKind(kind: Kind): Member = member.copy(kind = kind)
197197

198+
def withDocs(docs: Option[Comment]) = member.copy(docs = docs)
199+
198200
def withNewMembers(newMembers: Seq[Member]): Member =
199201
member.copy(members = member.members ++ newMembers)
200202

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,8 @@ case class ScaladocTastyInspector()(using ctx: DocContext) extends DocTastyInspe
160160
all.groupBy(_._1).map { case (pckName, members) =>
161161
val (pcks, rest) = members.map(_._2).partition(_.kind == Kind.Package)
162162
val basePck = pcks.reduce( (p1, p2) =>
163-
p1.withNewMembers(p2.members) // TODO add doc
163+
val withNewMembers = p1.withNewMembers(p2.members)
164+
if withNewMembers.docs.isEmpty then withNewMembers.withDocs(p2.docs) else withNewMembers
164165
)
165166
basePck.withMembers((basePck.members ++ rest).sortBy(_.name))
166167
}.toList -> rootDoc

0 commit comments

Comments
 (0)