go/lib/godoc/example.html

<div class="example">
	<div class="collapsed">
		<p class="exampleHeading">▹ Example</p>
	</div>
	<div class="expanded">
		<p class="exampleHeading">▾ Example</p>
		<p>Code:</p>
		<pre class="code">{{.Code}}</pre>
		{{if .Output}}
		<p>Output:</p>
		<pre class="output">{{html .Output}}</pre>
		{{end}}
	</div>
</div>
go/doc, godoc, gotest: support for reading example documentation This CL introduces the go.Example type and go.Examples functions that are used to represent and extract code samples from Go source. They should be of the form: // Output of this function. func ExampleFoo() { fmt.Println("Output of this function.") } It also modifies godoc to read example code from _test.go files, and include them in the HTML output with JavaScript-driven toggles. It also implements testing of example functions with gotest. The stdout/stderr is compared against the output comment on the function. This CL includes examples for the sort.Ints function and the sort.SortInts type. After patching this CL in and re-building go/doc and godoc, try godoc -http=localhost:6060 and visit http://localhost:6060/pkg/sort/ R=gri, r, rsc CC=golang-dev https://golang.org/cl/5137041 2011-10-06 12:56:17 -06:00			`<div class="example">`
			`<div class="collapsed">`
			`<p class="exampleHeading">▹ Example</p>`
			`</div>`
			`<div class="expanded">`
godoc: improved output of examples in html. Fixes #2467. Fixes #2464. R=golang-dev, rsc, adg CC=golang-dev https://golang.org/cl/5447051 2011-12-01 15:52:31 -07:00			`<p class="exampleHeading">▾ Example</p>`
			`<p>Code:</p>`
godoc: <pre> must not occur inside <p> Fixes #2532 R=golang-dev, dr.volker.dobler, rsc CC=golang-dev https://golang.org/cl/5450115 2011-12-07 13:00:38 -07:00			`<pre class="code">{{.Code}}</pre>`
godoc: improved output of examples in html. Fixes #2467. Fixes #2464. R=golang-dev, rsc, adg CC=golang-dev https://golang.org/cl/5447051 2011-12-01 15:52:31 -07:00			`{{if .Output}}`
go/doc, godoc, gotest: support for reading example documentation This CL introduces the go.Example type and go.Examples functions that are used to represent and extract code samples from Go source. They should be of the form: // Output of this function. func ExampleFoo() { fmt.Println("Output of this function.") } It also modifies godoc to read example code from _test.go files, and include them in the HTML output with JavaScript-driven toggles. It also implements testing of example functions with gotest. The stdout/stderr is compared against the output comment on the function. This CL includes examples for the sort.Ints function and the sort.SortInts type. After patching this CL in and re-building go/doc and godoc, try godoc -http=localhost:6060 and visit http://localhost:6060/pkg/sort/ R=gri, r, rsc CC=golang-dev https://golang.org/cl/5137041 2011-10-06 12:56:17 -06:00			`<p>Output:</p>`
godoc: <pre> must not occur inside <p> Fixes #2532 R=golang-dev, dr.volker.dobler, rsc CC=golang-dev https://golang.org/cl/5450115 2011-12-07 13:00:38 -07:00			`<pre class="output">{{html .Output}}</pre>`
godoc: improved output of examples in html. Fixes #2467. Fixes #2464. R=golang-dev, rsc, adg CC=golang-dev https://golang.org/cl/5447051 2011-12-01 15:52:31 -07:00			`{{end}}`
go/doc, godoc, gotest: support for reading example documentation This CL introduces the go.Example type and go.Examples functions that are used to represent and extract code samples from Go source. They should be of the form: // Output of this function. func ExampleFoo() { fmt.Println("Output of this function.") } It also modifies godoc to read example code from _test.go files, and include them in the HTML output with JavaScript-driven toggles. It also implements testing of example functions with gotest. The stdout/stderr is compared against the output comment on the function. This CL includes examples for the sort.Ints function and the sort.SortInts type. After patching this CL in and re-building go/doc and godoc, try godoc -http=localhost:6060 and visit http://localhost:6060/pkg/sort/ R=gri, r, rsc CC=golang-dev https://golang.org/cl/5137041 2011-10-06 12:56:17 -06:00			`</div>`
			`</div>`