qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-15 05:20:21 -07:00
Code Releases Activity

[release-branch.go1.2] cmd/godoc: document package-level examples

Browse Source 
««« CL 23940043 / 6ad0ec54cf2d
cmd/godoc: document package-level examples

Fixes  issue  5807 .

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/23940043

»»»

R=golang-dev
CC=golang-dev
https://golang.org/cl/25500045
This commit is contained in:
Andrew Gerrand 2013-11-13 14:35:59 +11:00
parent 1c961995ae
commit 021476db3b
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/pkg/testing/testing.go
View File

@ -73,17 +73,19 @@
// //
// Example functions without output comments are compiled but not executed. // Example functions without output comments are compiled but not executed.
// //
// The naming convention to declare examples for a function F, a type T and // The naming convention to declare examples for the package, a function F, a type T and
// method M on type T are: // method M on type T are:
// //
// func Example() { ... }
// func ExampleF() { ... } // func ExampleF() { ... }
// func ExampleT() { ... } // func ExampleT() { ... }
// func ExampleT_M() { ... } // func ExampleT_M() { ... }
// //
// Multiple example functions for a type/function/method may be provided by // Multiple example functions for a package/type/function/method may be provided by
// appending a distinct suffix to the name. The suffix must start with a // appending a distinct suffix to the name. The suffix must start with a
// lower-case letter. // lower-case letter.
// //
// func Example_suffix() { ... }
// func ExampleF_suffix() { ... } // func ExampleF_suffix() { ... }
// func ExampleT_suffix() { ... } // func ExampleT_suffix() { ... }
// func ExampleT_M_suffix() { ... } // func ExampleT_M_suffix() { ... }