Add example test and update documentation

koki · Dec 7, 2017 · 47a258f · 47a258f
1 parent 88b6d46
commit 47a258f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -890,19 +890,24 @@ fmt.Printf("%#v", f)
 // func init() {}
 ```
 
-### PackageComment
+### Comments
+HeaderComment adds a comment to the top of the file, above any package
+comments. A blank line is rendered below the header comments, ensuring
+header comments are not included in the package doc.
+
 PackageComment adds a comment to the top of the file, above the package
 keyword.
 
 ```go
 f := NewFile("c")
-f.PackageComment("a")
-f.PackageComment("b")
+f.HeaderComment("Code generated by...")
+f.PackageComment("Package c implements...")
 f.Func().Id("init").Params().Block()
 fmt.Printf("%#v", f)
 // Output:
-// // a
-// // b
+// // Code generated by...
+//
+// // Package c implements...
 // package c
 //
 // func init() {}

diff --git a/README.md.tpl b/README.md.tpl
@@ -383,10 +383,12 @@ avoid this, use Clone. {{ "Statement.Clone" | doc }}
 
 {{ "ExampleFile_Anon" | example }}
 
-### PackageComment
+### Comments
+{{ "File.HeaderComment" | doc }}
+
 {{ "File.PackageComment" | doc }}
 
-{{ "ExampleFile_PackageComment" | example }}
+{{ "ExampleFile_HeaderAndPackageComments" | example }}
 
 ### PackagePrefix
 {{ "File.PackagePrefix" | doc }}

diff --git a/jen/examples_test.go b/jen/examples_test.go
@@ -1218,15 +1218,16 @@ func ExampleNewFilePathName() {
 	// }
 }
 
-func ExampleFile_PackageComment() {
+func ExampleFile_HeaderAndPackageComments() {
 	f := NewFile("c")
-	f.PackageComment("a")
-	f.PackageComment("b")
+	f.HeaderComment("Code generated by...")
+	f.PackageComment("Package c implements...")
 	f.Func().Id("init").Params().Block()
 	fmt.Printf("%#v", f)
 	// Output:
-	// // a
-	// // b
+	// // Code generated by...
+	//
+	// // Package c implements...
 	// package c
 	//
 	// func init() {}