From 29e49a7a1caa2b344105f0e303f0addd1668276d Mon Sep 17 00:00:00 2001 From: Trek H Date: Wed, 8 May 2019 20:04:40 +0930 Subject: [PATCH] adpcm, pcm: updated documentation --- codec/adpcm/adpcm.go | 3 --- codec/pcm/pcm.go | 2 ++ exp/adpcm/decode-pcm/decode-pcm.go | 4 +--- exp/adpcm/encode-pcm/encode-pcm.go | 4 +--- exp/pcm/resample/resample.go | 5 ++--- exp/pcm/stereo-to-mono/stereo-to-mono.go | 5 ++--- 6 files changed, 8 insertions(+), 15 deletions(-) diff --git a/codec/adpcm/adpcm.go b/codec/adpcm/adpcm.go index fb67b283..013a76ff 100644 --- a/codec/adpcm/adpcm.go +++ b/codec/adpcm/adpcm.go @@ -2,9 +2,6 @@ NAME adpcm.go -DESCRIPTION - adpcm.go contains functions for encoding/compressing pcm into adpcm and decoding/decompressing back to pcm. - AUTHOR Trek Hopton diff --git a/codec/pcm/pcm.go b/codec/pcm/pcm.go index 5ead3143..bb200d50 100644 --- a/codec/pcm/pcm.go +++ b/codec/pcm/pcm.go @@ -24,6 +24,8 @@ 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 provides functions for processing and converting pcm audio. package pcm import ( diff --git a/exp/adpcm/decode-pcm/decode-pcm.go b/exp/adpcm/decode-pcm/decode-pcm.go index 8d2bd7f6..5db6887c 100644 --- a/exp/adpcm/decode-pcm/decode-pcm.go +++ b/exp/adpcm/decode-pcm/decode-pcm.go @@ -2,9 +2,6 @@ NAME decode-pcm.go -DESCRIPTION - decode-pcm.go is a program for decoding/decompressing an adpcm file to a pcm file. - AUTHOR Trek Hopton @@ -25,6 +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 main import ( diff --git a/exp/adpcm/encode-pcm/encode-pcm.go b/exp/adpcm/encode-pcm/encode-pcm.go index d283c822..69d42042 100644 --- a/exp/adpcm/encode-pcm/encode-pcm.go +++ b/exp/adpcm/encode-pcm/encode-pcm.go @@ -2,9 +2,6 @@ NAME encode-pcm.go -DESCRIPTION - encode-pcm.go is a program for encoding/compressing a pcm file to an adpcm file. - AUTHOR Trek Hopton @@ -25,6 +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 main import ( diff --git a/exp/pcm/resample/resample.go b/exp/pcm/resample/resample.go index eab7a342..3d595bb8 100644 --- a/exp/pcm/resample/resample.go +++ b/exp/pcm/resample/resample.go @@ -2,9 +2,6 @@ NAME resample.go -DESCRIPTION - resample.go is a program for resampling a pcm file. - AUTHOR Trek Hopton @@ -24,6 +21,8 @@ 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). */ + +// resample is a command-line program for resampling a pcm file. package main import ( diff --git a/exp/pcm/stereo-to-mono/stereo-to-mono.go b/exp/pcm/stereo-to-mono/stereo-to-mono.go index ccbf87bf..7dbfd9a5 100644 --- a/exp/pcm/stereo-to-mono/stereo-to-mono.go +++ b/exp/pcm/stereo-to-mono/stereo-to-mono.go @@ -2,9 +2,6 @@ NAME stereo-to-mono.go -DESCRIPTION - stereo-to-mono.go is a program for converting a mono pcm file to a stereo pcm file. - AUTHOR Trek Hopton @@ -24,6 +21,8 @@ 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). */ + +// stereo-to-mono is a command-line program for converting a mono pcm file to a stereo pcm file. package main import (