Merged in godoc (pull request #387)

Package level comments

Approved-by: Saxon Milton <saxon.milton@gmail.com>

cmd/audio-netsender/main.go

@@ -27,7 +27,7 @@ LICENSE
   If not, see http://www.gnu.org/licenses.
 */
 
-// audio-netsender is a NetSender client for sending audio to
+// Package audio-netsender is a NetSender client for sending audio to
 // NetReceiver. Audio is captured by means of an ALSA recording
 // device, specified by the NetReceiver "source" variable. It sent via
 // HTTP to NetReceiver in raw audio form, i.e., as PCM data, where it

cmd/audio-player/looper/main.go

@@ -24,7 +24,7 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
-// Looper is a bare bones program for repeated playback of an audio file.
+// Package looper is a bare bones program for repeated playback of an audio file.
 package main
 
 import (

codec/h264/extract.go

@@ -25,6 +25,9 @@ LICENSE
   along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
 */
 
+// Package h264 provides functionality for handling the H.264 video codec.
+// This includes extraction from an RTP stream, lexing of NAL units from
+// byte stream, and decoding.
 package h264
 
 import (

codec/h264/h264dec/helpers.go

@@ -4,6 +4,22 @@ DESCRIPTION
 
 AUTHORS
   Saxon Nelson-Milton <saxon@ausocean.org>, The Australian Ocean Laboratory (AusOcean)
+
+LICENSE
+  rtp.go is Copyright (C) 2018 the Australian Ocean Lab (AusOcean)
+
+  It is free software: you can redistribute it and/or modify them
+  under the terms of the GNU General Public License as published by the
+  Free Software Foundation, either version 3 of the License, or (at your
+  option) any later version.
+
+  It is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with revid in gpl.txt.  If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
 package h264dec

codec/mjpeg/extract.go

@@ -23,6 +23,9 @@ LICENSE
   along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
 */
 
+// Package mjpeg provides functionality for extraction of MJPEG from an
+// RTP-MJPEG stream and lexing of individual JPEGs from a bare bones
+// MJPEG stream.
 package mjpeg
 
 import (

codec/mjpeg/jpeg.go

@@ -30,7 +30,6 @@ LICENSE
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
 
-// Package mjpeg a lexer and decoder for mjpeg video.
 package mjpeg
 
 import (

codec/pcm/pcm_test.go

@@ -24,6 +24,7 @@ LICENSE
   You should have received a copy of the GNU General Public License in gpl.txt.
   If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
+
 package pcm
 
 import (

container/flv/encoder.go

@@ -1,6 +1,6 @@
 /*
 NAME
-  flv_generator.go
+  encoder.go
 
 DESCRIPTION
   See Readme.md

container/mts/pes/pes.go

@@ -1,6 +1,7 @@
 /*
 NAME
   pes.go -
+
 DESCRIPTION
   See Readme.md
 

container/mts/pes/pes_test.go

@@ -1,6 +1,6 @@
 /*
 NAME
-  mpegts_test.go
+  pes_test.go
 
 DESCRIPTION
   See Readme.md

container/mts/psi/helpers.go

@@ -1,6 +1,7 @@
 /*
 NAME
 	helpers.go
+
 DESCRIPTION
   helpers.go provides functionality for editing and reading bytes slices
 	directly in order to insert/read timestamp and location data in psi.

container/mts/psi/psi.go

@@ -1,6 +1,7 @@
 /*
 NAME
   psi.go
+
 DESCRIPTION
   See Readme.md
 
@@ -24,7 +25,7 @@ LICENSE
   along with revid in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
-// Package psi provides encoding of PSI packets.
+// Package psi provides encoding of MPEG-TS program specific information.
 package psi
 
 import (

container/mts/psi/psi_test.go

@@ -1,6 +1,7 @@
 /*
 NAME
   psi_test.go
+
 DESCRIPTION
   See Readme.md
 

container/mts/psi/std.go

@@ -1,6 +1,7 @@
 /*
 NAME
   std.go
+
 DESCRIPTION
   See Readme.md
 

device/device.go

@@ -24,6 +24,8 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
+// Package device provides an interface and implementations for input devices
+// that can be started and stopped from which media data can be obtained.
 package device
 
 import (

device/geovision/config/config-cli/main.go

@@ -22,7 +22,7 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
-// config-cli is a command-line program for configuring the GeoVision camera.
+// Package config-cli is a command-line program for configuring the GeoVision camera.
 package main
 
 import (

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 (

device/raspivid/raspivid_test.go

@@ -21,6 +21,7 @@ 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
 
 import (

device/webcam/webcam_test.go

@@ -21,6 +21,7 @@ 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
 
 import (

exp/adpcm/decode-pcm/decode-pcm.go

@@ -22,7 +22,7 @@ LICENSE
   If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
-// decode-pcm is a command-line program for decoding/decompressing an adpcm file to a pcm file.
+// Package decode-pcm is a command-line program for decoding/decompressing an adpcm file to a pcm file.
 package main
 
 import (

exp/adpcm/encode-pcm/encode-pcm.go

@@ -22,7 +22,7 @@ LICENSE
   If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
-// encode-pcm is a command-line program for encoding/compressing a pcm file to an adpcm file.
+// Package encode-pcm is a command-line program for encoding/compressing a pcm file to an adpcm file.
 package main
 
 import (

exp/flac/flac_test.go

@@ -24,6 +24,7 @@ LICENSE
   You should have received a copy of the GNU General Public License
   along with revid in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
+
 package flac
 
 import (

exp/pcm/resample/resample.go

@@ -22,7 +22,7 @@ LICENSE
   If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
-// resample is a command-line program for resampling a pcm file.
+// Package resample is a command-line program for resampling a pcm file.
 package main
 
 import (

exp/pcm/stereo-to-mono/stereo-to-mono.go

@@ -22,7 +22,7 @@ LICENSE
   If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
-// stereo-to-mono is a command-line program for converting a mono pcm file to a stereo pcm file.
+// Package stereo-to-mono is a command-line program for converting a mono pcm file to a stereo pcm file.
 package main
 
 import (

exp/rvcl/main.go

@@ -54,7 +54,7 @@ USAGE
   bitbucket.org/ausocean/av/device for input device specific variables.
 */
 
-// rvcl is a command line interface for revid.
+// Package rvcl is a command line interface for revid.
 package main
 
 import (

filter/filter.go

@@ -22,8 +22,8 @@ LICENSE
   in gpl.txt.  If not, see http://www.gnu.org/licenses.
 */
 
-// Package filter provides the interface and implementations of the filters to be used
-// on video input that has been lexed.
+// Package filter provides the interface and implementations of the filters
+// to be used on video input that has been lexed.
 package filter
 
 import (

protocol/rtp/rtp.go

@@ -1,11 +1,13 @@
 /*
 NAME
-  rtp.go - provides a data structure intended to encapsulate the properties
-  of an rtp packet and also functions to allow manipulation of these packets.
+  rtp.go
 
 DESCRIPTION
   See Readme.md
 
+  See https://tools.ietf.org/html/rfc6184 and https://tools.ietf.org/html/rfc3550
+  for rtp-h264 and rtp standards.
+
 AUTHOR
   Saxon A. Nelson-Milton <saxon@ausocean.org>
 
@@ -26,10 +28,8 @@ LICENSE
   along with revid in gpl.txt.  If not, see [GNU licenses](http://www.gnu.org/licenses).
 */
 
-/*
-See https://tools.ietf.org/html/rfc6184 and https://tools.ietf.org/html/rfc3550
-for rtp-h264 and rtp standards.
-*/
+// Package rtp provides a data structure intended to encapsulate the properties
+// of an rtp packet and also functions to allow manipulation of these packets.
 package rtp
 
 import (