1
0
mirror of https://github.com/golang/go synced 2024-11-21 16:04:45 -07:00
The Go programming language
Go to file
Volker Dobler a6729b3085 go/doc: Detect headings in comments and format them as h3 in html.
To structure larger sections of comments in html output headings
are detected in comments and formated as h3 in the generated html.
A simple heuristic is used to detect headings in comments:
A heading is a non-blank, non-indented line preceded by a blank
line. It is followed by a blank and a non-blank, non-indented line.
A heading must start with an uppercase letter and end with a letter,
digit or a colon.  A heading may not contain punctuation characters.

R=jan.mercl, gri, adg, rsc, r
CC=golang-dev
https://golang.org/cl/5437056
2011-12-01 09:49:58 -08:00
doc go/doc: Detect headings in comments and format them as h3 in html. 2011-12-01 09:49:58 -08:00
include lib9: add ctime 2011-11-07 13:15:16 -05:00
lib codereview: gofmt check for non-src/ files 2011-11-18 12:42:30 -08:00
misc dashboard: don't choke on weird builder names. 2011-12-01 16:37:30 +11:00
src go/doc: Detect headings in comments and format them as h3 in html. 2011-12-01 09:49:58 -08:00
test Add a []byte argument to hash.Hash to allow an allocation to be saved. 2011-12-01 12:35:37 -05:00
.hgignore misc/osx: Add scripts to create OS X package and disk image 2011-11-18 19:05:53 -06:00
.hgtags tag weekly.2011-12-01 2011-12-01 16:18:14 +11:00
AUTHORS C+A: add Gustav Paul (individual CLA) 2011-11-25 10:50:19 -05:00
CONTRIBUTORS CONTRIBUTORS: add Maxim Pimenov (Google CLA) 2011-11-28 11:47:23 -05: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

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.