From 892e1b92dadd3aa861d018c676ddb00898c96e8b Mon Sep 17 00:00:00 2001
From: Ella Pietraroia <ella@ausocean.org>
Date: Thu, 12 Mar 2020 15:56:29 +1030
Subject: [PATCH] device: package level comments

---
 device/alsa/alsa_test.go           | 1 +
 device/device.go                   | 3 +++
 device/file/file_test.go           | 1 +
 device/geovision/geovision_test.go | 2 ++
 device/raspivid/raspivid.go        | 3 ++-
 device/raspivid/raspivid_test.go   | 3 +++
 device/webcam/webcam_test.go       | 2 ++
 7 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/device/alsa/alsa_test.go b/device/alsa/alsa_test.go
index aeeb6ac9..b80840e8 100644
--- a/device/alsa/alsa_test.go
+++ b/device/alsa/alsa_test.go
@@ -23,6 +23,7 @@ LICENSE
   If not, see http://www.gnu.org/licenses.
 */
 
+// Package alsa provides access to input from ALSA audio devices.
 package alsa
 
 import (
diff --git a/device/device.go b/device/device.go
index efdc7043..b11b1586 100644
--- a/device/device.go
+++ b/device/device.go
@@ -24,6 +24,9 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
+// Package device provides AVDevice, an interface that describes a configurable
+// audio or video device that can be started and stopped from which data may
+// be obtained.
 package device
 
 import (
diff --git a/device/file/file_test.go b/device/file/file_test.go
index 6bf547f4..1f41b70b 100644
--- a/device/file/file_test.go
+++ b/device/file/file_test.go
@@ -22,6 +22,7 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
+// Package file provides an implementation of AVDevice for files.
 package file
 
 import (
diff --git a/device/geovision/geovision_test.go b/device/geovision/geovision_test.go
index 784313e3..590af15b 100644
--- a/device/geovision/geovision_test.go
+++ b/device/geovision/geovision_test.go
@@ -22,6 +22,8 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
+// Package geovision provides an implementation of the AVDevice interface
+// for the GeoVision IP camera.
 package geovision
 
 import (
diff --git a/device/raspivid/raspivid.go b/device/raspivid/raspivid.go
index d6311825..235000d9 100644
--- a/device/raspivid/raspivid.go
+++ b/device/raspivid/raspivid.go
@@ -22,7 +22,8 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
-// Package raspivid provides an implementation of AVDevice for the raspberry pi camera.
+// Package raspivid provides an implementation of AVDevice for the raspberry
+// pi camera.
 package raspivid
 
 import (
diff --git a/device/raspivid/raspivid_test.go b/device/raspivid/raspivid_test.go
index a1822317..104b7f40 100644
--- a/device/raspivid/raspivid_test.go
+++ b/device/raspivid/raspivid_test.go
@@ -21,6 +21,9 @@ LICENSE
   You should have received a copy of the GNU General Public License
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
+
+// Package raspivid provides an implementation of AVDevice for the raspberry
+// pi camera.
 package raspivid
 
 import (
diff --git a/device/webcam/webcam_test.go b/device/webcam/webcam_test.go
index 45f8e205..78b3d02f 100644
--- a/device/webcam/webcam_test.go
+++ b/device/webcam/webcam_test.go
@@ -21,6 +21,8 @@ LICENSE
   You should have received a copy of the GNU General Public License
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
+
+// Package webcam provides an implementation of AVDevice for webcams.
 package webcam
 
 import (