Skip to content

Commit 25b991c

Browse files
committed
Don't display private and make modifiers accessible from class members
1 parent 8d7f686 commit 25b991c

File tree

5 files changed

+15
-18
lines changed

5 files changed

+15
-18
lines changed

tastydoc/src/dotty/tastydoc/DocPrinter.scala

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -221,27 +221,29 @@ class DocPrinter(mutablePackagesMap: scala.collection.mutable.HashMap[String, Em
221221

222222
def formatMembers(): String = {
223223

224-
val typeMembers = representation.members.flatMap {
224+
val nonPrivateMembers = representation.members.filter(!_.isPrivate)
225+
226+
val typeMembers = nonPrivateMembers.flatMap {
225227
case r: TypeRepresentation => Some(r)
226228
case _ => None
227229
}
228-
val objectMembers = representation.members.flatMap {
230+
val objectMembers = nonPrivateMembers.flatMap {
229231
case r: ClassRepresentation if r.isObject => Some(r)
230232
case _ => None
231233
}
232-
val classMembers = representation.members.flatMap {
234+
val classMembers = nonPrivateMembers.flatMap {
233235
case r: ClassRepresentation if !r.isObject && !r.isTrait => Some(r)
234236
case _ => None
235237
}
236-
val traitMembers = representation.members.flatMap {
238+
val traitMembers = nonPrivateMembers.flatMap {
237239
case r: ClassRepresentation if r.isTrait => Some(r)
238240
case _ => None
239241
}
240-
val defMembers = representation.members.flatMap {
242+
val defMembers = nonPrivateMembers.flatMap {
241243
case r: DefRepresentation => Some(r)
242244
case _ => None
243245
}
244-
val valMembers = representation.members.flatMap {
246+
val valMembers = nonPrivateMembers.flatMap {
245247
case r: ValRepresentation => Some(r)
246248
case _ => None
247249
}

tastydoc/src/dotty/tastydoc/TastyExtractor.scala

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ trait TastyExtractor extends TastyTypeConverter with CommentParser with CommentC
5858
}
5959
}
6060

61-
def extractClassMembers(reflect: Reflection)(body: List[reflect.Statement], symbol: reflect.ClassDefSymbol, parentRepresentation: Some[Representation]) given (mutablePackagesMap: scala.collection.mutable.HashMap[String, EmulatedPackageRepresentation]) : List[Representation] = {
61+
def extractClassMembers(reflect: Reflection)(body: List[reflect.Statement], symbol: reflect.ClassDefSymbol, parentRepresentation: Some[Representation]) given (mutablePackagesMap: scala.collection.mutable.HashMap[String, EmulatedPackageRepresentation]) : List[Representation with Modifiers] = {
6262
import reflect._
6363

6464
/** Filter fields which shouldn't be displayed in the doc
@@ -81,6 +81,10 @@ trait TastyExtractor extends TastyTypeConverter with CommentParser with CommentC
8181
case x => Some(x)
8282
}.filter(x => filterSymbol(x.symbol)).map(convertToRepresentation(reflect)(_, parentRepresentation)) ++
8383
symbol.methods.filter(x => filterSymbol(x)).map{x => convertToRepresentation(reflect)(x.tree, parentRepresentation)})
84+
.flatMap{
85+
case r: Representation with Modifiers => Some(r)
86+
case _ => None
87+
}
8488
.sortBy(_.name)
8589
}
8690

tastydoc/src/dotty/tastydoc/representations.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ object representations extends TastyExtractor {
2222
}
2323

2424
trait Members {
25-
def members : List[Representation] //Is a def because so we can override with either a var or a val (Needed for EmulatedPackage)
25+
def members : List[Representation] //Is a def so we can override with either a var or a val (Needed for EmulatedPackage)
2626
}
2727

2828
trait Modifiers {
@@ -134,7 +134,7 @@ object representations extends TastyExtractor {
134134
override val name = internal.name
135135

136136
override val companion = extractCompanion(reflect)(internal.symbol.companionModule, internal.symbol.companionClass, !isObject)
137-
override val members = extractClassMembers(reflect)(internal.body, internal.symbol, Some(this))
137+
override val members: List[Representation with Modifiers] = extractClassMembers(reflect)(internal.body, internal.symbol, Some(this))
138138

139139
//Add itself to parents subclasses:
140140
parentRepresentation match {

tastydoc/zzz/example/level2/Documentation.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -397,9 +397,6 @@ Test methods with params
397397
### prefixLength
398398
<pre><code class="language-scala" >def prefixLength(p: (A) => Boolean): Int</pre></code>
399399

400-
### privateMethod
401-
<pre><code class="language-scala" >private def privateMethod: Nothing</pre></code>
402-
403400
### product
404401
<pre><code class="language-scala" >def product[B](num: Numeric[B]): B</pre></code>
405402

@@ -625,9 +622,6 @@ Test methods with params
625622
### iAmAVar
626623
<pre><code class="language-scala" >var iAmAVar: Nothing</pre></code>
627624

628-
### privateVal
629-
<pre><code class="language-scala" >private val privateVal: Nothing</pre></code>
630-
631625
### protectedVal
632626
<pre><code class="language-scala" >protected val protectedVal: Nothing</pre></code>
633627

tastydoc/zzz/scala/collection/immutable/List$.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ $factoryInfo
88

99
## Known subclasses:
1010
<a href="./List$/SerializationProxy.md">SerializationProxy</a>
11-
## Concrete Type Members:
12-
### SerializationProxy
13-
<pre><code class="language-scala" >@<a href="../../SerialVersionUID.md">SerialVersionUID</a> private class <a href="./List$/SerializationProxy.md">SerializationProxy</a></pre></code>
1411
## Concrete Value Members:
1512
### ReusableCBF
1613
<pre><code class="language-scala" >def ReusableCBF: GenericCanBuildFrom[<a href="../../Nothing.md">Nothing</a>]</pre></code>

0 commit comments

Comments
 (0)