From 295315a5ec83dc3173d6ae2437c11e1d8414f774 Mon Sep 17 00:00:00 2001
From: Jim Lawson
Date: Fri, 27 Jan 2017 10:58:38 -0800
Subject: Provide package-level text to reduce ScalaDoc white space. (#432)

---
 src/main/scala/chisel3/compatibility.scala   |  5 +++--
 src/main/scala/chisel3/package.scala         |  3 +++
 src/main/scala/chisel3/testers/package.scala | 10 ++++++++++
 src/main/scala/chisel3/util/util.scala       |  3 +++
 4 files changed, 19 insertions(+), 2 deletions(-)
 create mode 100644 src/main/scala/chisel3/testers/package.scala

(limited to 'src')

diff --git a/src/main/scala/chisel3/compatibility.scala b/src/main/scala/chisel3/compatibility.scala
index a919e3b9..d7ce7f24 100644
--- a/src/main/scala/chisel3/compatibility.scala
+++ b/src/main/scala/chisel3/compatibility.scala
@@ -1,7 +1,8 @@
 // See LICENSE for license details.
 
-// Allows legacy users to continue using Chisel (capital C) package name while
-// moving to the more standard package naming convention chisel3 (lowercase c).
+/** The Chisel compatibility package allows legacy users to continue using the `Chisel` (capital C) package name
+  *  while moving to the more standard package naming convention `chisel3` (lowercase c).
+  */
 
 package object Chisel {     // scalastyle:ignore package.object.name
   import chisel3.internal.firrtl.Width
diff --git a/src/main/scala/chisel3/package.scala b/src/main/scala/chisel3/package.scala
index 109bd14e..c3531f3a 100644
--- a/src/main/scala/chisel3/package.scala
+++ b/src/main/scala/chisel3/package.scala
@@ -1,5 +1,8 @@
 // See LICENSE for license details.
 
+/** The chisel3 package contains the chisel3 API.
+  * It maps core components into the public chisel3 namespace.
+  */
 package object chisel3 {    // scalastyle:ignore package.object.name
   import scala.language.implicitConversions
 
diff --git a/src/main/scala/chisel3/testers/package.scala b/src/main/scala/chisel3/testers/package.scala
new file mode 100644
index 00000000..649ea3d7
--- /dev/null
+++ b/src/main/scala/chisel3/testers/package.scala
@@ -0,0 +1,10 @@
+// See LICENSE for license details.
+
+package chisel3
+
+/** The testers package provides the basic interface for chisel testers.
+  *
+  */
+package object testers {
+
+}
\ No newline at end of file
diff --git a/src/main/scala/chisel3/util/util.scala b/src/main/scala/chisel3/util/util.scala
index 812af21c..129e5d1a 100644
--- a/src/main/scala/chisel3/util/util.scala
+++ b/src/main/scala/chisel3/util/util.scala
@@ -2,6 +2,9 @@
 
 package chisel3
 
+/** The util package provides extensions to core chisel for common hardware components and utility functions.
+  *
+  */
 package object util {
 
   /** Synonyms, moved from main package object - maintain scope. */
-- 
cgit v1.2.3