From 0b25fcc4e7c4bfcce66e309e83d22213465dd348 Mon Sep 17 00:00:00 2001
From: Gunnsteinn Hall <gunnsteinn.hall@gmail.com>
Date: Fri, 3 Aug 2018 10:18:44 +0000
Subject: [PATCH] golint and godoc fixes in textencoding

---
 pdf/model/textencoding/encoder.go             |  1 +
 pdf/model/textencoding/glyphs_glyphlist.go    |  3 ++-
 pdf/model/textencoding/glyphs_zapfdingbats.go |  2 +-
 pdf/model/textencoding/identity.go            |  4 ++--
 pdf/model/textencoding/truetype.go            | 10 +++++-----
 5 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/pdf/model/textencoding/encoder.go b/pdf/model/textencoding/encoder.go
index ef391b7c..4f0c12b3 100644
--- a/pdf/model/textencoding/encoder.go
+++ b/pdf/model/textencoding/encoder.go
@@ -10,6 +10,7 @@ import (
 	"github.com/unidoc/unidoc/pdf/core"
 )
 
+// TextEncoder defines the common methods that a text encoder implementation must have in UniDoc.
 type TextEncoder interface {
 	// String returns a string that describes the TextEncoder instance.
 	String() string
diff --git a/pdf/model/textencoding/glyphs_glyphlist.go b/pdf/model/textencoding/glyphs_glyphlist.go
index 715581e3..e726acae 100644
--- a/pdf/model/textencoding/glyphs_glyphlist.go
+++ b/pdf/model/textencoding/glyphs_glyphlist.go
@@ -4,7 +4,8 @@
  */
 /*
  * The embedded glyph to unicode mappings specified in this file are distributed under the terms
- * listed in ./glyphlist/glyphlist.txt, ./glyphlist/texglyphlist.txt and ./glyphlist/addtional.txt
+ * listed in ./testdata/glyphlist/glyphlist.txt, ./testdata/glyphlist/texglyphlist.txt
+ * and ./tesdtdata/glyphlist/addtional.txt
  */
 
 package textencoding
diff --git a/pdf/model/textencoding/glyphs_zapfdingbats.go b/pdf/model/textencoding/glyphs_zapfdingbats.go
index 15de908b..d19110c6 100644
--- a/pdf/model/textencoding/glyphs_zapfdingbats.go
+++ b/pdf/model/textencoding/glyphs_zapfdingbats.go
@@ -4,7 +4,7 @@
  */
 /*
  * The embedded glyph to unicode mappings specified in this file are distributed under the terms listed in
- * ./glyphlist/zapfdingbats.txt.
+ * ./testdata/glyphlist/zapfdingbats.txt.
  */
 
 package textencoding
diff --git a/pdf/model/textencoding/identity.go b/pdf/model/textencoding/identity.go
index eb333304..eeeb22c1 100644
--- a/pdf/model/textencoding/identity.go
+++ b/pdf/model/textencoding/identity.go
@@ -18,8 +18,8 @@ type IdentityEncoder struct {
 	baseName string
 }
 
-// NewSimpleTextEncoder returns a IdentityEncoder based on predefined encoding `baseName` and
-// difference map `differences`.
+// NewIdentityTextEncoder returns a new IdentityEncoder based on predefined
+// encoding `baseName` and difference map `differences`.
 func NewIdentityTextEncoder(baseName string) IdentityEncoder {
 	return IdentityEncoder{baseName}
 }
diff --git a/pdf/model/textencoding/truetype.go b/pdf/model/textencoding/truetype.go
index 25d274cb..ebfb8163 100644
--- a/pdf/model/textencoding/truetype.go
+++ b/pdf/model/textencoding/truetype.go
@@ -38,14 +38,14 @@ func NewTrueTypeFontEncoder(runeToGlyphIndexMap map[uint16]uint16) TrueTypeFontE
 // ttEncoderNumEntries is the maximum number of encoding entries shown in SimpleEncoder.String()
 const ttEncoderNumEntries = 1000
 
-// String returns a string that describes `se`.
-func (se TrueTypeFontEncoder) String() string {
+// String returns a string that describes `enc`.
+func (enc TrueTypeFontEncoder) String() string {
 	parts := []string{
-		fmt.Sprintf("%d entries", len(se.runeToGlyphIndexMap)),
+		fmt.Sprintf("%d entries", len(enc.runeToGlyphIndexMap)),
 	}
 
 	codes := []int{}
-	for c := range se.runeToGlyphIndexMap {
+	for c := range enc.runeToGlyphIndexMap {
 		codes = append(codes, int(c))
 	}
 	sort.Ints(codes)
@@ -57,7 +57,7 @@ func (se TrueTypeFontEncoder) String() string {
 	for i := 0; i < numCodes; i++ {
 		c := codes[i]
 		parts = append(parts, fmt.Sprintf("%d=0x%02x: %q",
-			c, c, se.runeToGlyphIndexMap[uint16(c)]))
+			c, c, enc.runeToGlyphIndexMap[uint16(c)]))
 	}
 	return fmt.Sprintf("TRUETYPE_ENCODER{%s}", strings.Join(parts, ", "))
 }