diff --git a/codec/h264/extract.go b/codec/h264/extract.go index dfe07e7c..9c7da115 100644 --- a/codec/h264/extract.go +++ b/codec/h264/extract.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 h264 import ( diff --git a/codec/h264/h264dec/decode.go b/codec/h264/h264dec/decode.go index 9cb1e7b1..f209de5b 100644 --- a/codec/h264/h264dec/decode.go +++ b/codec/h264/h264dec/decode.go @@ -22,6 +22,7 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package h264dec provides a decoder for h264 frames. package h264dec import ( diff --git a/codec/h264/h264dec/helpers.go b/codec/h264/h264dec/helpers.go index 92124cec..d215b839 100644 --- a/codec/h264/h264dec/helpers.go +++ b/codec/h264/h264dec/helpers.go @@ -5,6 +5,7 @@ DESCRIPTION AUTHORS Saxon Nelson-Milton , The Australian Ocean Laboratory (AusOcean) */ + package h264dec import ( diff --git a/codec/h264/lex_test.go b/codec/h264/lex_test.go index 87e6b7d2..c6db34e2 100644 --- a/codec/h264/lex_test.go +++ b/codec/h264/lex_test.go @@ -26,8 +26,6 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ -// lex_test.go provides tests for the lexer in lex.go. - package h264 import ( diff --git a/codec/mjpeg/jpeg.go b/codec/mjpeg/jpeg.go index 6506fc39..be09289a 100644 --- a/codec/mjpeg/jpeg.go +++ b/codec/mjpeg/jpeg.go @@ -30,6 +30,7 @@ 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 ( diff --git a/container/flv/encoder.go b/container/flv/encoder.go index 6014a15f..7355af43 100644 --- a/container/flv/encoder.go +++ b/container/flv/encoder.go @@ -25,6 +25,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 flv import ( diff --git a/container/flv/flv.go b/container/flv/flv.go index 8ae7e050..36e44a21 100644 --- a/container/flv/flv.go +++ b/container/flv/flv.go @@ -29,6 +29,7 @@ LICENSE // See https://wwwimages2.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10.pdf // for format specification. +// Package flv provides FLV encoding and related functions. package flv import "encoding/binary" diff --git a/container/mts/meta/meta.go b/container/mts/meta/meta.go index 4b2f8c9f..9fca245d 100644 --- a/container/mts/meta/meta.go +++ b/container/mts/meta/meta.go @@ -3,7 +3,8 @@ NAME meta.go DESCRIPTION - See Readme.md + Package meta provides functions for adding to, modifying and reading + metadata, as well as encoding and decoding functions. AUTHOR Saxon Nelson-Milton @@ -25,6 +26,8 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package meta provides functions for adding to, modifying and reading +// metadata, as well as encoding and decoding functions. package meta import ( diff --git a/container/mts/meta/meta_test.go b/container/mts/meta/meta_test.go index 9316ce55..2b40284d 100644 --- a/container/mts/meta/meta_test.go +++ b/container/mts/meta/meta_test.go @@ -2,9 +2,6 @@ NAME meta_test.go -DESCRIPTION - See Readme.md - AUTHOR Saxon Nelson-Milton diff --git a/container/mts/pes/pes.go b/container/mts/pes/pes.go index 5b5cb612..3de57e11 100644 --- a/container/mts/pes/pes.go +++ b/container/mts/pes/pes.go @@ -24,6 +24,7 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package pes provides encoding of PES packets. package pes import "github.com/Comcast/gots" diff --git a/container/mts/psi/psi.go b/container/mts/psi/psi.go index 3703faf4..8af447f1 100644 --- a/container/mts/psi/psi.go +++ b/container/mts/psi/psi.go @@ -24,6 +24,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 import ( diff --git a/device/file/file.go b/device/file/file.go index d068ace6..0ec2d928 100644 --- a/device/file/file.go +++ b/device/file/file.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/config/config-cli/main.go b/device/geovision/config/config-cli/main.go index 9956d264..72cab4d7 100644 --- a/device/geovision/config/config-cli/main.go +++ b/device/geovision/config/config-cli/main.go @@ -22,6 +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 main import ( diff --git a/device/geovision/geovision.go b/device/geovision/geovision.go index decf1e80..35b554fd 100644 --- a/device/geovision/geovision.go +++ b/device/geovision/geovision.go @@ -23,6 +23,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 d47fc346..d6311825 100644 --- a/device/raspivid/raspivid.go +++ b/device/raspivid/raspivid.go @@ -22,6 +22,7 @@ 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.go b/device/webcam/webcam.go index bb41b7cf..22472702 100644 --- a/device/webcam/webcam.go +++ b/device/webcam/webcam.go @@ -22,6 +22,7 @@ LICENSE in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package webcam provides an implementation of AVDevice for webcams. package webcam import ( diff --git a/exp/flac/decode.go b/exp/flac/decode.go index 34d42057..903c358d 100644 --- a/exp/flac/decode.go +++ b/exp/flac/decode.go @@ -24,6 +24,8 @@ 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 provides functionality for the decoding of FLAC compressed audio. package flac import ( diff --git a/revid/config/config.go b/revid/config/config.go index 48a9f288..42d6b94c 100644 --- a/revid/config/config.go +++ b/revid/config/config.go @@ -23,6 +23,7 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package config contains the configuration settings for revid. package config import ( diff --git a/revid/config/parameter/generate_parameters.go b/revid/config/parameter/generate_parameters.go index 62b743bd..dacdc1bf 100644 --- a/revid/config/parameter/generate_parameters.go +++ b/revid/config/parameter/generate_parameters.go @@ -161,6 +161,7 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package parameter is autogenerated code for config parameters - DO NOT EDIT. package parameter import ( diff --git a/revid/config/parameter/parameters.go b/revid/config/parameter/parameters.go index 10c2a1a3..6d0fa773 100644 --- a/revid/config/parameter/parameters.go +++ b/revid/config/parameter/parameters.go @@ -25,6 +25,7 @@ LICENSE along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. */ +// Package parameter is autogenerated code for config parameters - DO NOT EDIT. package parameter import (