Fix comments accordingly with golint advices

Refs to issue grafov#151.

Author: grafov

doc.go

@@ -1,8 +1,12 @@
-/* Package M3U8 is parser & generator library for Apple HLS.
+// Package m3u8 is parser & generator library for Apple HLS.
 
-This is a most complete opensource library for parsing and generating of M3U8 playlists used in HTTP Live Streaming (Apple HLS) for internet video translations.
+/* This is a most complete opensource library for parsing and
+   generating of M3U8 playlists used in HTTP Live Streaming (Apple
+   HLS) for internet video translations.
 
-M3U8 is simple text format and parsing library for it must be simple too. It did not offer ways to play HLS or handle playlists over HTTP. Library features are:
+M3U8 is simple text format and parsing library for it must be simple
+too. It did not offer ways to play HLS or handle playlists over
+HTTP. Library features are:
 
   * Support HLS specs up to version 5 of the protocol.
   * Parsing and generation of master-playlists and media-playlists.
@@ -11,11 +15,14 @@ M3U8 is simple text format and parsing library for it must be simple too. It did
   * Encryption keys support for usage with DRM systems like Verimatrix (http://verimatrix.com) etc.
   * Support for non standard Google Widevine (http://www.widevine.com) tags.
 
-Library coded accordingly with IETF draft http://tools.ietf.org/html/draft-pantos-http-live-streaming
+Library coded accordingly with IETF draft
+http://tools.ietf.org/html/draft-pantos-http-live-streaming
 
-Examples of usage may be found in *_test.go files of a package. Also see below some simple examples.
+Examples of usage may be found in *_test.go files of a package. Also
+see below some simple examples.
 
-Create simple media playlist with sliding window of 3 segments and maximum of 50 segments.
+Create simple media playlist with sliding window of 3 segments and
+maximum of 50 segments.
 
 		p, e := NewMediaPlaylist(3, 50)
 		if e != nil {
@@ -29,7 +36,8 @@ Create simple media playlist with sliding window of 3 segments and maximum of 50
 		}
 		fmt.Println(p.Encode(true).String())
 
-We add 5 testX.ts segments to playlist then encode it to M3U8 format and convert to string.
+We add 5 testX.ts segments to playlist then encode it to M3U8 format
+and convert to string.
 
 Next example shows parsing of master playlist:
 
@@ -46,8 +54,8 @@ Next example shows parsing of master playlist:
 		fmt.Printf("Playlist object: %+v\n", p)
 
 We are open playlist from the file and parse it as master playlist.
-
 */
+
 package m3u8
 
 // Copyright 2013-2019 The Project Developers.

example/template/custom-playlist-tag-template.go

@@ -10,29 +10,33 @@ import (
 
 // #CUSTOM-PLAYLIST-TAG:<number>
 
-// Implements both CustomTag and CustomDecoder interfaces
+// CustomPlaylistTag implements both CustomTag and CustomDecoder
+// interfaces.
 type CustomPlaylistTag struct {
 	Number int
 }
 
-// TagName() should return the full indentifier including the leading '#' and trailing ':'
-// if the tag also contains a value or attribute list
+// TagName should return the full indentifier including the leading
+// '#' and trailing ':' if the tag also contains a value or attribute
+// list.
 func (tag *CustomPlaylistTag) TagName() string {
 	return "#CUSTOM-PLAYLIST-TAG:"
 }
 
-// line will be the entire matched line, including the identifier
+// Decode decodes the input line. The line will be the entire matched
+// line, including the identifier
 func (tag *CustomPlaylistTag) Decode(line string) (m3u8.CustomTag, error) {
 	_, err := fmt.Sscanf(line, "#CUSTOM-PLAYLIST-TAG:%d", &tag.Number)
 
 	return tag, err
 }
 
-// This is a playlist tag example
+// SegmentTag is a playlist tag example.
 func (tag *CustomPlaylistTag) SegmentTag() bool {
 	return false
 }
 
+// Encode formats the structure to the text result.
 func (tag *CustomPlaylistTag) Encode() *bytes.Buffer {
 	buf := new(bytes.Buffer)
 
@@ -42,6 +46,7 @@ func (tag *CustomPlaylistTag) Encode() *bytes.Buffer {
 	return buf
 }
 
+// String implements Stringer interface.
 func (tag *CustomPlaylistTag) String() string {
 	return tag.Encode().String()
 }

example/template/custom-segment-tag-template.go

@@ -9,19 +9,21 @@ import (
 
 // #CUSTOM-SEGMENT-TAG:<attribute-list>
 
-// Implements both CustomTag and CustomDecoder interfaces
+// CustomSegmentTag implements both CustomTag and CustomDecoder
+// interfaces.
 type CustomSegmentTag struct {
 	Name string
 	Jedi bool
 }
 
-// TagName() should return the full indentifier including the leading '#' and trailing ':'
+// TagName should return the full indentifier including the leading '#' and trailing ':'
 // if the tag also contains a value or attribute list
 func (tag *CustomSegmentTag) TagName() string {
 	return "#CUSTOM-SEGMENT-TAG:"
 }
 
-// line will be the entire matched line, including the identifier
+// Decode decodes the input string to the internal structure. The line
+// will be the entire matched line, including the identifier.
 func (tag *CustomSegmentTag) Decode(line string) (m3u8.CustomTag, error) {
 	var err error
 
@@ -47,11 +49,12 @@ func (tag *CustomSegmentTag) Decode(line string) (m3u8.CustomTag, error) {
 	return newTag, err
 }
 
-// This is a playlist tag example
+// SegmentTag is a playlist tag example.
 func (tag *CustomSegmentTag) SegmentTag() bool {
 	return true
 }
 
+// Encode encodes the structure to the text result.
 func (tag *CustomSegmentTag) Encode() *bytes.Buffer {
 	buf := new(bytes.Buffer)
 
@@ -70,6 +73,7 @@ func (tag *CustomSegmentTag) Encode() *bytes.Buffer {
 	return buf
 }
 
+// String implements Stringer interface.
 func (tag *CustomSegmentTag) String() string {
 	return tag.Encode().String()
 }

structure.go

@@ -31,8 +31,12 @@ const (
 		   o  The EXT-X-MEDIA tag.
 		   o  The AUDIO and VIDEO attributes of the EXT-X-STREAM-INF tag.
 	*/
-	minver   = uint8(3)
-	DATETIME = time.RFC3339Nano // Format for EXT-X-PROGRAM-DATE-TIME defined in section 3.4.5
+	minver = uint8(3)
+
+	// DATETIME represents format of the timestamps in encoded
+	// playlists. Format for EXT-X-PROGRAM-DATE-TIME defined in
+	// section 3.4.5
+	DATETIME = time.RFC3339Nano
 )
 
 // ListType is type of the playlist.
@@ -74,34 +78,33 @@ const (
 	SCTE35Cue_End                        // SCTE35Cue_End indicates an in cue point
 )
 
-/*
- MediaPlaylist structure represents a single bitrate playlist aka media playlist.
- It related to both a simple media playlists and a sliding window media playlists.
- URI lines in the Playlist point to media segments.
-
- Simple Media Playlist file sample:
-
-   #EXTM3U
-   #EXT-X-VERSION:3
-   #EXT-X-TARGETDURATION:5220
-   #EXTINF:5219.2,
-   http://media.example.com/entire.ts
-   #EXT-X-ENDLIST
-
- Sample of Sliding Window Media Playlist, using HTTPS:
-
-   #EXTM3U
-   #EXT-X-VERSION:3
-   #EXT-X-TARGETDURATION:8
-   #EXT-X-MEDIA-SEQUENCE:2680
-
-   #EXTINF:7.975,
-   https://priv.example.com/fileSequence2680.ts
-   #EXTINF:7.941,
-   https://priv.example.com/fileSequence2681.ts
-   #EXTINF:7.975,
-   https://priv.example.com/fileSequence2682.ts
-*/
+// MediaPlaylist structure represents a single bitrate playlist aka
+// media playlist. It related to both a simple media playlists and a
+// sliding window media playlists. URI lines in the Playlist point to
+// media segments.
+//
+// Simple Media Playlist file sample:
+//
+//    #EXTM3U
+//    #EXT-X-VERSION:3
+//    #EXT-X-TARGETDURATION:5220
+//    #EXTINF:5219.2,
+//    http://media.example.com/entire.ts
+//    #EXT-X-ENDLIST
+//
+// Sample of Sliding Window Media Playlist, using HTTPS:
+//
+//    #EXTM3U
+//    #EXT-X-VERSION:3
+//    #EXT-X-TARGETDURATION:8
+//    #EXT-X-MEDIA-SEQUENCE:2680
+//
+//    #EXTINF:7.975,
+//    https://priv.example.com/fileSequence2680.ts
+//    #EXTINF:7.941,
+//    https://priv.example.com/fileSequence2681.ts
+//    #EXTINF:7.975,
+//    https://priv.example.com/fileSequence2682.ts
 type MediaPlaylist struct {
 	TargetDuration   float64
 	SeqNo            uint64 // EXT-X-MEDIA-SEQUENCE
@@ -129,21 +132,19 @@ type MediaPlaylist struct {
 	customDecoders   []CustomDecoder
 }
 
-/*
- MasterPlaylist structure represents a master playlist which combines media playlists for multiple bitrates.
- URI lines in the playlist identify media playlists.
- Sample of Master Playlist file:
-
-   #EXTM3U
-   #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=1280000
-   http://example.com/low.m3u8
-   #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=2560000
-   http://example.com/mid.m3u8
-   #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=7680000
-   http://example.com/hi.m3u8
-   #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=65000,CODECS="mp4a.40.5"
-   http://example.com/audio-only.m3u8
-*/
+// MasterPlaylist structure represents a master playlist which
+// combines media playlists for multiple bitrates. URI lines in the
+// playlist identify media playlists. Sample of Master Playlist file:
+//
+//    #EXTM3U
+//    #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=1280000
+//    http://example.com/low.m3u8
+//    #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=2560000
+//    http://example.com/mid.m3u8
+//    #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=7680000
+//    http://example.com/hi.m3u8
+//    #EXT-X-STREAM-INF:PROGRAM-ID=1,BANDWIDTH=65000,CODECS="mp4a.40.5"
+//    http://example.com/audio-only.m3u8
 type MasterPlaylist struct {
 	Variants            []*Variant
 	Args                string // optional arguments placed after URI (URI?Args)
@@ -241,7 +242,7 @@ type Key struct {
 // Initialization Section required to parse the applicable
 // Media Segments.
 //
-// It applies to every Media Segment that appears after it in the
+// It applied to every Media Segment that appears after it in the
 // Playlist until the next EXT-X-MAP tag or until the end of the
 // playlist.
 //

writer.go

@@ -21,9 +21,8 @@ import (
 	"time"
 )
 
-var (
-	ErrPlaylistFull = errors.New("playlist is full")
-)
+// ErrPlaylistFull declares the playlist error.
+var ErrPlaylistFull = errors.New("playlist is full")
 
 // Set version of the playlist accordingly with section 7
 func version(ver *uint8, newver uint8) {
@@ -94,7 +93,7 @@ func (p *MasterPlaylist) Encode() *bytes.Buffer {
 		}
 	}
 
-	var altsWritten map[string]bool = make(map[string]bool)
+	var altsWritten = make(map[string]bool)
 
 	for _, pl := range p.Variants {
 		if pl.Alternatives != nil {
@@ -853,7 +852,8 @@ func (p *MediaPlaylist) SetProgramDateTime(value time.Time) error {
 	return nil
 }
 
-// SetCustomTag sets the provided tag on the media playlist for its TagName
+// SetCustomTag sets the provided tag on the media playlist for its
+// TagName.
 func (p *MediaPlaylist) SetCustomTag(tag CustomTag) {
 	if p.Custom == nil {
 		p.Custom = make(map[string]CustomTag)
@@ -862,7 +862,8 @@ func (p *MediaPlaylist) SetCustomTag(tag CustomTag) {
 	p.Custom[tag.TagName()] = tag
 }
 
-// SetCustomTag sets the provided tag on the current media segment for its TagName
+// SetCustomSegmentTag sets the provided tag on the current media
+// segment for its TagName.
 func (p *MediaPlaylist) SetCustomSegmentTag(tag CustomTag) error {
 	if p.count == 0 {
 		return errors.New("playlist is empty")