From 0ad178301750c28267670fd19b95930d7b52c020 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Tue, 13 Jul 2021 12:25:17 +0200 Subject: [PATCH] Hide private members in documentation (#30370) Co-Authored-By: Arnout Engelen Co-authored-by: Andrei Arlou --- project/Doc.scala | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/project/Doc.scala b/project/Doc.scala index 08d6efd5e9..27c23c7d98 100644 --- a/project/Doc.scala +++ b/project/Doc.scala @@ -159,10 +159,21 @@ object UnidocRoot extends AutoPlugin { UnidocRoot.CliOptions.genjavadocEnabled .ifTrue( Seq( - // akka.stream.scaladsl.GraphDSL.Implicits.ReversePortsOps contains code that - // genjavadoc turns into (probably incorrect) Java code that in turn confuses the javadoc tool. JavaUnidoc / unidocAllSources ~= { v => - v.map(_.filterNot(_.getAbsolutePath.endsWith("scaladsl/GraphDSL.java"))) + v.map(_.filterNot(s => + // akka.stream.scaladsl.GraphDSL.Implicits.ReversePortsOps + // contains code that genjavadoc turns into (probably + // incorrect) Java code that in turn confuses the javadoc + // tool. + s.getAbsolutePath.endsWith("scaladsl/GraphDSL.java") || + // Since adding -P:genjavadoc:strictVisibility=true, + // the javadoc tool would NullPointerException while + // determining the upper bound for some generics: + s.getAbsolutePath.endsWith("TopicImpl.java") || + s.getAbsolutePath.endsWith("PersistencePlugin.java") || + s.getAbsolutePath.endsWith("GraphDelegate.java") || + s.getAbsolutePath.contains("/impl/") + )) })) .getOrElse(Nil)) } @@ -186,6 +197,6 @@ object BootstrapGenjavadoc extends AutoPlugin { override lazy val projectSettings = UnidocRoot.CliOptions.genjavadocEnabled .ifTrue(Seq( unidocGenjavadocVersion := "0.17", - Compile / scalacOptions ++= Seq("-P:genjavadoc:fabricateParams=false", "-P:genjavadoc:suppressSynthetic=false"))) + Compile / scalacOptions ++= Seq("-P:genjavadoc:fabricateParams=false", "-P:genjavadoc:suppressSynthetic=false", "-P:genjavadoc:strictVisibility=true"))) .getOrElse(Nil) }