Merged in godoc (pull request #383)

Fix package level comments

Approved-by: Saxon Milton <saxon.milton@gmail.com>
This commit is contained in:
Scott Barnard 2020-02-29 05:05:55 +00:00 committed by Saxon Milton
commit 1901e4271e
20 changed files with 23 additions and 6 deletions

View File

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

View File

@ -22,6 +22,7 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package h264dec provides a decoder for h264 frames.
package h264dec package h264dec
import ( import (

View File

@ -5,6 +5,7 @@ DESCRIPTION
AUTHORS AUTHORS
Saxon Nelson-Milton <saxon@ausocean.org>, The Australian Ocean Laboratory (AusOcean) Saxon Nelson-Milton <saxon@ausocean.org>, The Australian Ocean Laboratory (AusOcean)
*/ */
package h264dec package h264dec
import ( import (

View File

@ -26,8 +26,6 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package h264
import ( import (

View File

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

View File

@ -25,6 +25,7 @@ LICENSE
You should have received a copy of the GNU General Public 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. along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
package flv package flv
import ( import (

View File

@ -29,6 +29,7 @@ LICENSE
// See https://wwwimages2.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10.pdf // See https://wwwimages2.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10.pdf
// for format specification. // for format specification.
// Package flv provides FLV encoding and related functions.
package flv package flv
import "encoding/binary" import "encoding/binary"

View File

@ -3,7 +3,8 @@ NAME
meta.go meta.go
DESCRIPTION DESCRIPTION
See Readme.md Package meta provides functions for adding to, modifying and reading
metadata, as well as encoding and decoding functions.
AUTHOR AUTHOR
Saxon Nelson-Milton <saxon@ausocean.org> Saxon Nelson-Milton <saxon@ausocean.org>
@ -25,6 +26,8 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package meta
import ( import (

View File

@ -2,9 +2,6 @@
NAME NAME
meta_test.go meta_test.go
DESCRIPTION
See Readme.md
AUTHOR AUTHOR
Saxon Nelson-Milton <saxon@ausocean.org> Saxon Nelson-Milton <saxon@ausocean.org>

View File

@ -24,6 +24,7 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package pes provides encoding of PES packets.
package pes package pes
import "github.com/Comcast/gots" import "github.com/Comcast/gots"

View File

@ -24,6 +24,7 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package psi provides encoding of PSI packets.
package psi package psi
import ( import (

View File

@ -22,6 +22,7 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package file provides an implementation of AVDevice for files.
package file package file
import ( import (

View File

@ -22,6 +22,7 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package main
import ( import (

View File

@ -23,6 +23,8 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package geovision
import ( import (

View File

@ -22,6 +22,7 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package raspivid
import ( import (

View File

@ -22,6 +22,7 @@ LICENSE
in gpl.txt. If not, see http://www.gnu.org/licenses. in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package webcam provides an implementation of AVDevice for webcams.
package webcam package webcam
import ( import (

View File

@ -24,6 +24,8 @@ LICENSE
You should have received a copy of the GNU General Public 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. 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 package flac
import ( import (

View File

@ -23,6 +23,7 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. along with revid in gpl.txt. If not, see http://www.gnu.org/licenses.
*/ */
// Package config contains the configuration settings for revid.
package config package config
import ( import (

View File

@ -161,6 +161,7 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package parameter
import ( import (

View File

@ -25,6 +25,7 @@ LICENSE
along with revid in gpl.txt. If not, see http://www.gnu.org/licenses. 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 package parameter
import ( import (