From 5a85e213ffa23e01aaee1f8d9468e7e675203d9f Mon Sep 17 00:00:00 2001
From: Jack Koenig
Date: Wed, 1 Dec 2021 10:43:56 -0800
Subject: Ignore firrtl.antlr package in API doc generation

The classes should not really be part of the firrtl public API to begin
with and they cause issues during ScalaDoc generation.
---
 build.sbt | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'build.sbt')

diff --git a/build.sbt b/build.sbt
index 0ff2effa..9fba6a6b 100644
--- a/build.sbt
+++ b/build.sbt
@@ -130,6 +130,9 @@ lazy val docSettings = Seq(
   Compile / doc := (ScalaUnidoc / doc).value,
   autoAPIMappings := true,
   Compile / doc / scalacOptions ++= Seq(
+    // ANTLR-generated classes aren't really part of public API and cause
+    // errors in ScalaDoc generation
+    "-skip-packages", "firrtl.antlr",
     "-Xfatal-warnings",
     "-feature",
     "-diagrams",
-- 
cgit v1.2.3