Skip to content

Fix Definition classes brief comments in Scala3doc #10805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions scala3doc-testcases/src/tests/overrides.scala
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package tests
package overrides

class A:
trait A:
def defInt: Int = 1

class B extends A:
trait B extends A:
override def defInt: Int = 2

class C extends B:
override def defInt: Int = 3
trait C extends B

class D extends C:
override def defInt: Int = 4
2 changes: 1 addition & 1 deletion scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala
Original file line number Diff line number Diff line change
Expand Up @@ -466,4 +466,4 @@ trait ClassLikeSupport:
ctx.sourceSet.toSet,
/*isExpectActual =*/ false,
PropertyContainer.Companion.empty().plus(member.copy(rawDoc = symbol.documentation2)).plus(compositeExt)
)
)
14 changes: 10 additions & 4 deletions scala3doc/src/dotty/renderers/MemberRenderer.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,18 @@ class MemberRenderer(signatureRenderer: SignatureRenderer, buildNode: ContentNod
def defintionClasses(m: Member) = m.origin match
case Origin.Overrides(defs) =>
def renderDef(d: Overriden): Seq[TagArg] =
Seq(signatureRenderer.renderLink(d.name, d.dri), " -> ")

val nodes: Seq[TagArg] = defs.flatMap(renderDef).dropRight(1) // drop trailing arrow
Seq(" -> ", signatureRenderer.renderLink(d.name, d.dri))
val headNode = m.inheritedFrom.map(signatureRenderer.renderLink(_, _))
val tailNodes = defs.flatMap(renderDef)
val nodes = headNode.fold(tailNodes.drop(1))(_ +: tailNodes)
tableRow("Definition Classes", div(nodes:_*))

case _ => Nil

def inheritedFrom(m: Member) = m.inheritedFrom match
case Some(InheritedFrom(name, dri)) => tableRow("Inhertied from", signatureRenderer.renderLink(name, dri))
case _ => Nil

def docAttributes(m: Member): Seq[AppliedTag] =

def nested(name: String, on: SortedMap[String, DocPart]): Seq[AppliedTag] =
Expand Down Expand Up @@ -113,6 +118,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer, buildNode: ContentNod
companion(m),
deprecation(m),
defintionClasses(m),
inheritedFrom(m),
source(m),
)
)
Expand Down Expand Up @@ -361,4 +367,4 @@ class MemberRenderer(signatureRenderer: SignatureRenderer, buildNode: ContentNod
memberInfo(m),
classLikeParts(m),
buildDocumentableFilter, // TODO Need to make it work in JS :(
buildMembers(m))
buildMembers(m))