Left: | ||
Right: |
LEFT | RIGHT |
---|---|
1 // Copyright 2009 The Go Authors. All rights reserved. | 1 // Copyright 2009 The Go Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style | 2 // Use of this source code is governed by a BSD-style |
3 // license that can be found in the LICENSE file. | 3 // license that can be found in the LICENSE file. |
4 | 4 |
5 /* | 5 /* |
6 | 6 |
7 Godoc extracts and generates documentation for Go programs. | 7 Godoc extracts and generates documentation for Go programs. |
8 | 8 |
9 It has two modes. | 9 It has two modes. |
10 | 10 |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
79 directory containing alternate template files; if set, | 79 directory containing alternate template files; if set, |
80 the directory may provide alternative template files | 80 the directory may provide alternative template files |
81 for the files in $GOROOT/lib/godoc | 81 for the files in $GOROOT/lib/godoc |
82 -url=path | 82 -url=path |
83 print to standard output the data that would be served by | 83 print to standard output the data that would be served by |
84 an HTTP request for path | 84 an HTTP request for path |
85 -zip="" | 85 -zip="" |
86 zip file providing the file system to serve; disabled if empty | 86 zip file providing the file system to serve; disabled if empty |
87 | 87 |
88 By default, godoc looks at the packages it finds via $GOROOT and $GOPATH (if set ). | 88 By default, godoc looks at the packages it finds via $GOROOT and $GOPATH (if set ). |
89 Additional directories may be specified via the -path flag which accepts a list | 89 This behavior can be altered by providing an alternative $GOROOT with the -goroo t |
gri
2012/07/09 17:55:37
This section needs to be updated as well
dfc
2012/07/10 08:47:01
Done.
| |
90 of colon-separated paths; unrooted paths are relative to the current working | 90 flag. |
91 directory. Each path is considered as an additional root for packages in order | |
92 of appearance. The last (absolute) path element is the prefix for the package | |
93 path. For instance, given the flag value: | |
94 | |
95 » path=".:/home/bar:/public" | |
96 | |
97 for a godoc started in /home/user/godoc, absolute paths are mapped to package pa ths | |
98 as follows: | |
99 | |
100 » /home/user/godoc/x -> godoc/x | |
101 » /home/bar/x -> bar/x | |
102 » /public/x -> public/x | |
103 | 91 |
104 When godoc runs as a web server and -index is set, a search index is maintained. | 92 When godoc runs as a web server and -index is set, a search index is maintained. |
105 The index is created at startup. | 93 The index is created at startup. |
106 | 94 |
107 The index contains both identifier and full text search information (searchable | 95 The index contains both identifier and full text search information (searchable |
108 via regular expressions). The maximum number of full text search results shown | 96 via regular expressions). The maximum number of full text search results shown |
109 can be set with the -maxresults flag; if set to 0, no full text results are | 97 can be set with the -maxresults flag; if set to 0, no full text results are |
110 shown, and only an identifier index but no full text search index is created. | 98 shown, and only an identifier index but no full text search index is created. |
111 | 99 |
112 The presentation mode of web pages served by godoc can be controlled with the | 100 The presentation mode of web pages served by godoc can be controlled with the |
(...skipping 20 matching lines...) Expand all Loading... | |
133 | 121 |
134 one may run godoc as follows: | 122 one may run godoc as follows: |
135 | 123 |
136 godoc -http=:6060 -zip=go.zip -goroot=$HOME/go | 124 godoc -http=:6060 -zip=go.zip -goroot=$HOME/go |
137 | 125 |
138 See "Godoc: documenting Go code" for how to write good comments for godoc: | 126 See "Godoc: documenting Go code" for how to write good comments for godoc: |
139 http://golang.org/doc/articles/godoc_documenting_go_code.html | 127 http://golang.org/doc/articles/godoc_documenting_go_code.html |
140 | 128 |
141 */ | 129 */ |
142 package documentation | 130 package documentation |
LEFT | RIGHT |