codec: updated commenting and file header descriptions for files in h265 and mjpeg packages

This commit is contained in:
Saxon 2019-05-03 19:52:23 +09:30
parent 5d6e3171bf
commit 314a8dab9a
4 changed files with 6 additions and 6 deletions

View File

@ -3,7 +3,7 @@ NAME
lex.go lex.go
DESCRIPTION DESCRIPTION
See Readme.md lex.go provides a lexer to lex h264 bytestream into access units.
AUTHOR AUTHOR
Dan Kortschak <dan@ausocean.org> Dan Kortschak <dan@ausocean.org>
@ -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

@ -3,7 +3,7 @@ NAME
lex_test.go lex_test.go
DESCRIPTION DESCRIPTION
See Readme.md lex_test.go provides tests for the lexer in lex.go.
AUTHOR AUTHOR
Dan Kortschak <dan@ausocean.org> Dan Kortschak <dan@ausocean.org>

View File

@ -3,7 +3,7 @@ NAME
lex.go lex.go
DESCRIPTION DESCRIPTION
See Readme.md lex.go provides a lexer to extract separate JPEG images from a MJPEG stream.
AUTHOR AUTHOR
Dan Kortschak <dan@ausocean.org> Dan Kortschak <dan@ausocean.org>
@ -25,7 +25,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.
*/ */
// Package lex provides lexers for video encodings.
package mjpeg package mjpeg
import ( import (
@ -42,7 +41,7 @@ func init() {
close(noDelay) close(noDelay)
} }
// MJPEG parses MJPEG frames read from src into separate writes to dst with // Lex parses MJPEG frames read from src into separate writes to dst with
// successive writes being performed not earlier than the specified delay. // successive writes being performed not earlier than the specified delay.
func Lex(dst io.Writer, src io.Reader, delay time.Duration) error { func Lex(dst io.Writer, src io.Reader, delay time.Duration) error {
var tick <-chan time.Time var tick <-chan time.Time

View File

@ -3,7 +3,7 @@ NAME
lex_test.go lex_test.go
DESCRIPTION DESCRIPTION
See Readme.md lex_test.go provides testing for the lexer in lex.go.
AUTHOR AUTHOR
Dan Kortschak <dan@ausocean.org> Dan Kortschak <dan@ausocean.org>