qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-22 03:44:39 -07:00
Code Releases Activity

doc/articles: update reference to obsolete "package documentation".

Browse Source 
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/7475048
This commit is contained in:
David Symonds 2013-03-26 13:01:24 +11:00
parent 5e74f5029b
commit 1e0e65ea59
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/articles/godoc_documenting_go_code.html
View File

@ -91,10 +91,9 @@ known issue from the <a href="/pkg/bytes/#pkg-bugs"><code>bytes</code></a> packa
</pre>
<p>
Godoc treats executable commands somewhat differently. Instead of inspecting the
command source code, it looks for a Go source file belonging to the special
package "documentation". The comment on the "package documentation" clause is
used as the command's documentation. For example, see the
Godoc treats executable commands in the same way. It looks for a comment on
package main, which is sometimes put in a separate file called <code>doc.go</code>.
For example, see the
<a href="/cmd/godoc/">godoc documentation</a> and its corresponding
<a href="/src/cmd/godoc/doc.go">doc.go</a> file.
</p>