• Andrew Gerrand's avatar
    go/doc, godoc, gotest: support for reading example documentation · af1ae438
    Andrew Gerrand authored
    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
    af1ae438
Name
Last commit
Last update
..
archive Loading commit data...
asn1 Loading commit data...
big Loading commit data...
bufio Loading commit data...
builtin Loading commit data...
bytes Loading commit data...
cmath Loading commit data...
compress Loading commit data...
container Loading commit data...
crypto Loading commit data...
csv Loading commit data...
debug Loading commit data...
ebnf Loading commit data...
encoding Loading commit data...
exec Loading commit data...
exp Loading commit data...
expvar Loading commit data...
flag Loading commit data...
fmt Loading commit data...
go Loading commit data...
gob Loading commit data...
hash Loading commit data...
html Loading commit data...
http Loading commit data...
image Loading commit data...
index/suffixarray Loading commit data...
io Loading commit data...
json Loading commit data...
log Loading commit data...
mail Loading commit data...
math Loading commit data...
mime Loading commit data...
net Loading commit data...
netchan Loading commit data...
old Loading commit data...
os Loading commit data...
patch Loading commit data...
path Loading commit data...
rand Loading commit data...
reflect Loading commit data...
regexp Loading commit data...
rpc Loading commit data...
runtime Loading commit data...
scanner Loading commit data...
smtp Loading commit data...
sort Loading commit data...
strconv Loading commit data...
strings Loading commit data...
sync Loading commit data...
syscall Loading commit data...
syslog Loading commit data...
tabwriter Loading commit data...
template Loading commit data...
testing Loading commit data...
time Loading commit data...
try Loading commit data...
unicode Loading commit data...
unsafe Loading commit data...
url Loading commit data...
utf16 Loading commit data...
utf8 Loading commit data...
websocket Loading commit data...
xml Loading commit data...
Makefile Loading commit data...
deps.bash Loading commit data...