aboutsummaryrefslogtreecommitdiff
path: root/doc-tool
diff options
context:
space:
mode:
authorFelix Mulder <felix.mulder@gmail.com>2017-01-17 10:23:09 +0100
committerFelix Mulder <felix.mulder@gmail.com>2017-01-31 14:32:38 +0100
commit92796201dff87cc8ae0b16d06f6892d8af69ccef (patch)
tree8f3bee1b9433e919c3001e8e9ce463925bccf183 /doc-tool
parentabb54e75568f38bcc3f731de137b67e59752e4d7 (diff)
downloaddotty-92796201dff87cc8ae0b16d06f6892d8af69ccef.tar.gz
dotty-92796201dff87cc8ae0b16d06f6892d8af69ccef.tar.bz2
dotty-92796201dff87cc8ae0b16d06f6892d8af69ccef.zip
Hide private & protected members by default
Diffstat (limited to 'doc-tool')
-rw-r--r--doc-tool/resources/_layouts/api-page.html2
-rw-r--r--doc-tool/resources/css/api-page.css8
-rw-r--r--doc-tool/src/dotty/tools/dottydoc/model/entities.scala3
-rw-r--r--doc-tool/src/dotty/tools/dottydoc/model/java.scala34
4 files changed, 35 insertions, 12 deletions
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:
<div id="entity-members" class="entity-section">
{% for member in entity.members %}
- <div class="member">
+ <div class="member {% if member.isPrivate %}private{% elsif member.isProtected %}protected{% endif %}">
<div class="member-title">
<span class="member-annotations">
{% 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
}