qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-24 22:57:57 -07:00
Code Releases Activity
The Go programming language
11,379 Commits 58 Branches 402 Tags 522 MiB
Go 89.6%
Assembly 5.2%
HTML 4.8%
C 0.2%
Shell 0.1%
6d68be46dd
Go to file
Robert Griesemer 6d68be46dd go/doc: clean rewrite of go/doc internals 
The implementation is divided into 4 phases:
1) export filtering of an incoming AST if necessary (exports.go)
2) reading of a possibly filtered AST (reader.go: type reader)
3) method set computation (reader.go)
4) sorting and creation of final documentation (reader.go)

In contrast to the old implementation, the presentation data
(Names, Docs, Decls, etc.) are created immediately upon reading
the respective AST node. Also, all types are collected (embedded
or not) in a uniform way.

Once the entire AST has been processed, all methods and types
have been collected and the method sets for each type can be
computed (phase 3).

To produce the final documentation, the method sets and value
maps are sorted.

There are no API changes. Passes the existing test suite unchanged.

R=rsc, rogpeppe
CC=golang-dev
https://golang.org/cl/5554044
2012-01-25 09:53:26 -08:00
doc doc/go1: mime, filepath.Walk 2012-01-24 17:02:06 -08:00
include os: OS-dependent bits to support NetBSD. 2011-12-15 12:19:19 -05:00
lib lib/godoc: use Type.Name directly 2012-01-23 16:08:05 -08:00
misc test: Add the usual Copyright notice. 2012-01-24 14:48:15 -05:00
src go/doc: clean rewrite of go/doc internals 2012-01-25 09:53:26 -08:00
test test: Add the usual Copyright notice. 2012-01-24 14:48:15 -05:00
.hgignore .hgignore: ignore autogenerated files 2011-12-20 15:54:39 -05:00
.hgtags tag weekly.2012-01-20 2012-01-20 17:01:55 +11:00
AUTHORS A+C: Berengar Lehr (individual CLA) 2012-01-20 13:34:25 -05:00
CONTRIBUTORS CONTRIBUTORS: add Alexandru Moșoi <brtzsnr@gmail.com> 2012-01-23 08:49:30 -08:00
favicon.ico add a favicon plus a couple of hi-res versions of gordon 2009-10-26 10:13:07 -07:00
LICENSE LICENSE: separate, change PATENTS text 2010-12-06 16:31:59 -05:00
PATENTS LICENSE: separate, change PATENTS text 2010-12-06 16:31:59 -05:00
README build: update, streamline documentation for new $GOBIN 2010-08-24 20:00:50 -04:00
robots.txt godoc: serve robots.txt raw 2011-02-19 05:46:20 +11:00

README 

This is the source code repository for the Go programming language.  

For documentation about how to install and use Go,
visit http://golang.org/ or load doc/install.html in your web browser.

After installing Go, you can view a nicely formatted
doc/install.html by running godoc --http=:6060
and then visiting http://localhost:6060/doc/install.html.

Unless otherwise noted, the Go source files are distributed
under the BSD-style license found in the LICENSE file.

--

Binary Distribution Notes

If you have just untarred a binary Go distribution, you need to set
the environment variable $GOROOT to the full path of the go
directory (the one containing this README).  You can omit the
variable if you unpack it into /usr/local/go, or if you rebuild
from sources by running all.bash (see doc/install.html).
You should also add the Go binary directory $GOROOT/bin
to your shell's path.

For example, if you extracted the tar file into $HOME/go, you might
put the following in your .profile:

    export GOROOT=$HOME/go
    export PATH=$PATH:$GOROOT/bin

See doc/install.html for more details.