qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-21 14:24:44 -07:00
Code Releases Activity
af1ae438b9
go/doc
History
Andrew Gerrand af1ae438b9 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 11:56:17 -07:00
..
codelab/wiki doc/codelab/wiki: fix Makefile 2011-08-29 09:24:24 -04:00
codewalk doc/codewalk: new Markov chain codewalk 2011-08-17 15:53:17 +10:00
devel doc: document r60.2 2011-10-05 13:59:39 -07:00
gopher doc/gopher: add a small gif to use as an app engine logo on GAE pages. 2011-06-14 17:25:57 +10:00
play godoc: add dummy playground.js to silence godoc warning at start-up 2011-08-22 14:06:07 -07:00
progs doc/progs: fix windows/amd64 2011-08-29 15:38:12 -04:00
talks doc/talks/io2010: handle the errors 2011-07-19 14:10:12 +10:00
all.css go/doc, godoc, gotest: support for reading example documentation 2011-10-06 11:56:17 -07:00
button_background.png golang.org redesign 2010-09-16 14:01:02 +10:00
code.html doc: there's no such thing as a .cgo file 2011-03-04 16:28:27 +11:00
codereview_with_mq.html doc: various changes for validating HTML 2010-08-30 09:58:27 +10:00
community.html golang.org redesign 2010-09-16 14:01:02 +10:00
contrib.html doc: put Release History link on 'Documentation' page 2011-05-27 16:07:30 +10:00
contribute.html contrib*.html: make "golang-dev" the default reviewer. 2011-05-13 16:25:31 -07:00
debugging_with_gdb.html documentation: Debugging Go code with GDB tutorial. 2011-10-05 10:49:23 -07:00
docs.html doc: link to Czech translation of The Laws of Reflection 2011-10-05 12:45:56 -07:00
effective_go.html Effective Go: IntArray -> IntSlice 2011-10-06 10:46:18 -07:00
effective_go.tmpl Effective Go: IntArray -> IntSlice 2011-10-06 10:46:18 -07:00
ExpressivenessOfGo.pdf fix bug in example. need to convert Value to float in Abs example 2010-10-18 16:05:50 -07:00
frontpage.css doc: add I/O 2011 talks to talks/, docs.html, and front page. 2011-05-17 13:46:54 +10:00
gccgo_contribute.html docs: make "runtime" a word only as a name for the package. 2011-03-01 13:54:22 -08:00
gccgo_install.html doc: when configuring gold for gccgo, use --enable-gold=default 2011-09-19 11:54:07 -07:00
go_faq.html FAQ: variant types, unions 2011-08-06 11:21:59 +10:00
go_for_cpp_programmers.html docs: make "runtime" a word only as a name for the package. 2011-03-01 13:54:22 -08:00
go_mem.html doc: fix memory model read visibility bug 2011-09-26 12:54:30 -04:00
go_spec.html go spec: remove notes about gccgo limitations, now fixed 2011-09-29 14:50:55 -07:00
go_tutorial.html doc: update tutorial. 2011-10-03 16:18:47 -07:00
go_tutorial.tmpl doc: update tutorial. 2011-10-03 16:18:47 -07:00
go-logo-black.png godoc: style update. 2009-11-05 12:18:54 -08:00
go-logo-blue.png Update the styling of the godoc pages. 2009-11-03 19:59:45 -08:00
go-logo-white.png create doc/talks/. 2010-01-13 16:26:22 -08:00
GoCourseDay1.pdf doc/GoCourseDay1: shrink the PDF by rewriting it using ps2pdf. 2011-06-20 12:36:14 +10:00
GoCourseDay2.pdf docs: Update notes for 3-day Go course. 2011-06-10 15:05:51 +10:00
GoCourseDay3.pdf docs: Update notes for 3-day Go course. 2011-06-10 15:05:51 +10:00
godocs.js go/doc, godoc, gotest: support for reading example documentation 2011-10-06 11:56:17 -07:00
ie.css golang.org redesign 2010-09-16 14:01:02 +10:00
install.html doc: link to A Tour of Go 2011-10-05 11:12:07 -07:00
logo-153x55.png new logo 2009-10-12 22:58:32 -07:00
logo.png golang.org redesign 2010-09-16 14:01:02 +10:00
Makefile effective_go: convert to use tmpltohtml. 2011-08-21 09:46:19 +10:00
makehtml effective_go: convert to use tmpltohtml. 2011-08-21 09:46:19 +10:00
play_overlay.png golang.org redesign 2010-09-16 14:01:02 +10:00
playground.html playground.html: filesystem is not a word. 2010-10-06 23:56:13 +02:00
popups.js godoc: initial support for showing popup information 2010-03-16 14:17:42 -07:00
root.html doc: link to A Tour of Go 2011-10-05 11:12:07 -07:00
sieve.gif repair corrupted sieve.gif 2009-10-30 10:34:01 -07:00
tmpltohtml.go doc/tmpltohtml: update to new template package. 2011-08-21 09:04:21 +10:00
video-001.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-002.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-003.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-004.png doc: add Practical Go Programming to front page and docs.html 2010-12-03 06:57:30 +09:00
video-005.jpg doc: add I/O 2011 talks to talks/, docs.html, and front page. 2011-05-17 13:46:54 +10:00