From 92796201dff87cc8ae0b16d06f6892d8af69ccef Mon Sep 17 00:00:00 2001 From: Felix Mulder Date: Tue, 17 Jan 2017 10:23:09 +0100 Subject: Hide private & protected members by default --- doc-tool/resources/_layouts/api-page.html | 2 +- doc-tool/resources/css/api-page.css | 8 +++++ .../src/dotty/tools/dottydoc/model/entities.scala | 3 ++ doc-tool/src/dotty/tools/dottydoc/model/java.scala | 34 +++++++++++++++------- 4 files changed, 35 insertions(+), 12 deletions(-) (limited to 'doc-tool') diff --git a/doc-tool/resources/_layouts/api-page.html b/doc-tool/resources/_layouts/api-page.html index a3d9008e3..e32da6a14 100644 --- a/doc-tool/resources/_layouts/api-page.html +++ b/doc-tool/resources/_layouts/api-page.html @@ -27,7 +27,7 @@ extraCSS:
{% for member in entity.members %} -
+
{% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %} diff --git a/doc-tool/resources/css/api-page.css b/doc-tool/resources/css/api-page.css index 9b18b6f6a..feda8f486 100644 --- a/doc-tool/resources/css/api-page.css +++ b/doc-tool/resources/css/api-page.css @@ -38,6 +38,14 @@ h1.section { margin: 30px 0; } +div#entity-members > div.member.protected { + display: none; +} + +div#entity-members > div.member.private { + display: none; +} + div#entity-members > div.member { margin-bottom: 30px; } diff --git a/doc-tool/src/dotty/tools/dottydoc/model/entities.scala b/doc-tool/src/dotty/tools/dottydoc/model/entities.scala index 295b6568a..e9d388c3b 100644 --- a/doc-tool/src/dotty/tools/dottydoc/model/entities.scala +++ b/doc-tool/src/dotty/tools/dottydoc/model/entities.scala @@ -53,6 +53,9 @@ trait Modifiers { val isPrivate: Boolean = modifiers.contains("private") + + val isProtected: Boolean = + modifiers.contains("protected") } trait TypeParams { diff --git a/doc-tool/src/dotty/tools/dottydoc/model/java.scala b/doc-tool/src/dotty/tools/dottydoc/model/java.scala index c46414061..331699957 100644 --- a/doc-tool/src/dotty/tools/dottydoc/model/java.scala +++ b/doc-tool/src/dotty/tools/dottydoc/model/java.scala @@ -57,15 +57,17 @@ object java { implicit class JavaCaseClass(val ent: CaseClass) extends AnyVal { def asJava(extras: Map[String, _] = Map.empty): JMap[String, _] = (Map( - "kind" -> ent.kind, + "kind" -> ent.kind, "annotations" -> ent.annotations.asJava, - "name" -> ent.name, - "members" -> ent.members.map(_.asJava()).asJava, - "modifiers" -> ent.modifiers.asJava, - "path" -> ent.path.asJava, + "name" -> ent.name, + "members" -> ent.members.map(_.asJava()).asJava, + "modifiers" -> ent.modifiers.asJava, + "path" -> ent.path.asJava, "typeParams" -> ent.typeParams.asJava, "superTypes" -> ent.superTypes.map(_.asJava).asJava, - "comment" -> ent.comment.map(_.asJava).asJava + "comment" -> ent.comment.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ) ++ extras).asJava } @@ -79,7 +81,9 @@ object java { "path" -> ent.path.asJava, "typeParams" -> ent.typeParams.asJava, "superTypes" -> ent.superTypes.map(_.asJava).asJava, - "comment" -> ent.comment.map(_.asJava).asJava + "comment" -> ent.comment.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ) ++ extras).asJava } @@ -93,7 +97,9 @@ object java { "path" -> ent.path.asJava, "typeParams" -> ent.typeParams.asJava, "superTypes" -> ent.superTypes.map(_.asJava).asJava, - "comment" -> ent.comment.map(_.asJava).asJava + "comment" -> ent.comment.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ) ++ extras).asJava } @@ -106,7 +112,9 @@ object java { "modifiers" -> ent.modifiers.asJava, "path" -> ent.path.asJava, "superTypes" -> ent.superTypes.map(_.asJava).asJava, - "comment" -> ent.comment.map(_.asJava).asJava + "comment" -> ent.comment.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ) ++ extras).asJava } @@ -121,7 +129,9 @@ object java { "typeParams" -> ent.typeParams.asJava, "paramLists" -> ent.paramLists.map(_.asJava).asJava, "comment" -> ent.comment.map(_.asJava).asJava, - "implicitlyAddedFrom" -> ent.implicitlyAddedFrom.map(_.asJava).asJava + "implicitlyAddedFrom" -> ent.implicitlyAddedFrom.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ).asJava } @@ -134,7 +144,9 @@ object java { "path" -> ent.path.asJava, "returnValue" -> ent.returnValue.asJava, "comment" -> ent.comment.map(_.asJava).asJava, - "implicitlyAddedFrom" -> ent.implicitlyAddedFrom.map(_.asJava).asJava + "implicitlyAddedFrom" -> ent.implicitlyAddedFrom.map(_.asJava).asJava, + "isPrivate" -> ent.isPrivate, + "isProtected" -> ent.isProtected ).asJava } -- cgit v1.2.3