font/gofont: add style descriptions to the generated package docs.
Fixes golang/go#17964
Change-Id: I3b9f567db7e613a5fcf8fc5e3d4d9f15069fd19b
Reviewed-on: https://go-review.googlesource.com/33370
Reviewed-by: Rob Pike <r@golang.org>
diff --git a/font/gofont/gen.go b/font/gofont/gen.go
index 66eb9c3..c7cf2d8 100644
--- a/font/gofont/gen.go
+++ b/font/gofont/gen.go
@@ -60,9 +60,17 @@
log.Fatal(err)
}
+ desc := "a proportional-width, sans-serif"
+ if strings.Contains(ttfName, "Mono") {
+ desc = "a fixed-width, slab-serif"
+ }
+
b := new(bytes.Buffer)
fmt.Fprintf(b, "// generated by go run gen.go; DO NOT EDIT\n\n")
- fmt.Fprintf(b, "// Package %s provides the %q TrueType font\n// from the Go font family.\n", pkgName, fontName)
+ fmt.Fprintf(b, "// Package %s provides the %q TrueType font\n", pkgName, fontName)
+ fmt.Fprintf(b, "// from the Go font family. It is %s font.\n", desc)
+ fmt.Fprintf(b, "//\n")
+ fmt.Fprintf(b, "// See https://blog.golang.org/go-fonts for details.\n")
fmt.Fprintf(b, "package %s\n\n", pkgName)
fmt.Fprintf(b, "// TTF is the data for the %q TrueType font.\n", fontName)
fmt.Fprintf(b, "var TTF = []byte{")
diff --git a/font/gofont/gobold/data.go b/font/gofont/gobold/data.go
index 2759346..fe2d5e9 100644
--- a/font/gofont/gobold/data.go
+++ b/font/gofont/gobold/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gobold provides the "Go Bold" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gobold
// TTF is the data for the "Go Bold" TrueType font.
diff --git a/font/gofont/gobolditalic/data.go b/font/gofont/gobolditalic/data.go
index ce9ab8c..7d45c77 100644
--- a/font/gofont/gobolditalic/data.go
+++ b/font/gofont/gobolditalic/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gobolditalic provides the "Go Bold Italic" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gobolditalic
// TTF is the data for the "Go Bold Italic" TrueType font.
diff --git a/font/gofont/goitalic/data.go b/font/gofont/goitalic/data.go
index ad6dc8c..cfa095f 100644
--- a/font/gofont/goitalic/data.go
+++ b/font/gofont/goitalic/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package goitalic provides the "Go Italic" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package goitalic
// TTF is the data for the "Go Italic" TrueType font.
diff --git a/font/gofont/gomedium/data.go b/font/gofont/gomedium/data.go
index 5d6525b..85de45d 100644
--- a/font/gofont/gomedium/data.go
+++ b/font/gofont/gomedium/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomedium provides the "Go Medium" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomedium
// TTF is the data for the "Go Medium" TrueType font.
diff --git a/font/gofont/gomediumitalic/data.go b/font/gofont/gomediumitalic/data.go
index fa62fa2..d968fd5 100644
--- a/font/gofont/gomediumitalic/data.go
+++ b/font/gofont/gomediumitalic/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomediumitalic provides the "Go Medium Italic" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomediumitalic
// TTF is the data for the "Go Medium Italic" TrueType font.
diff --git a/font/gofont/gomono/data.go b/font/gofont/gomono/data.go
index 9f1ac8b..b1afd47 100644
--- a/font/gofont/gomono/data.go
+++ b/font/gofont/gomono/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomono provides the "Go Mono" TrueType font
-// from the Go font family.
+// from the Go font family. It is a fixed-width, slab-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomono
// TTF is the data for the "Go Mono" TrueType font.
diff --git a/font/gofont/gomonobold/data.go b/font/gofont/gomonobold/data.go
index 6891109..d76fcd0 100644
--- a/font/gofont/gomonobold/data.go
+++ b/font/gofont/gomonobold/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomonobold provides the "Go Mono Bold" TrueType font
-// from the Go font family.
+// from the Go font family. It is a fixed-width, slab-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomonobold
// TTF is the data for the "Go Mono Bold" TrueType font.
diff --git a/font/gofont/gomonobolditalic/data.go b/font/gofont/gomonobolditalic/data.go
index 5a4fa09..155b07e 100644
--- a/font/gofont/gomonobolditalic/data.go
+++ b/font/gofont/gomonobolditalic/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomonobolditalic provides the "Go Mono Bold Italic" TrueType font
-// from the Go font family.
+// from the Go font family. It is a fixed-width, slab-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomonobolditalic
// TTF is the data for the "Go Mono Bold Italic" TrueType font.
diff --git a/font/gofont/gomonoitalic/data.go b/font/gofont/gomonoitalic/data.go
index 44b5a28..25d598d 100644
--- a/font/gofont/gomonoitalic/data.go
+++ b/font/gofont/gomonoitalic/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package gomonoitalic provides the "Go Mono Italic" TrueType font
-// from the Go font family.
+// from the Go font family. It is a fixed-width, slab-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package gomonoitalic
// TTF is the data for the "Go Mono Italic" TrueType font.
diff --git a/font/gofont/goregular/data.go b/font/gofont/goregular/data.go
index 663e51d..a0138f6 100644
--- a/font/gofont/goregular/data.go
+++ b/font/gofont/goregular/data.go
@@ -1,7 +1,9 @@
// generated by go run gen.go; DO NOT EDIT
// Package goregular provides the "Go Regular" TrueType font
-// from the Go font family.
+// from the Go font family. It is a proportional-width, sans-serif font.
+//
+// See https://blog.golang.org/go-fonts for details.
package goregular
// TTF is the data for the "Go Regular" TrueType font.
