From 1d95d02fef91ccb91bc4829424af56a3d907ea31 Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Wed, 2 Oct 2013 22:08:24 -0400 Subject: [PATCH] go.tools/cmd/godoc: point at doc.ToHTML documentation for formatting rules Fixes golang/go#5429. R=golang-dev, r CC=golang-dev https://golang.org/cl/14292043 --- cmd/godoc/doc.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cmd/godoc/doc.go b/cmd/godoc/doc.go index 1fa57a8b..d29e807d 100644 --- a/cmd/godoc/doc.go +++ b/cmd/godoc/doc.go @@ -128,6 +128,8 @@ one may run godoc as follows: godoc -http=:6060 -zip=go.zip -goroot=$HOME/go +Godoc documentation is converted to HTML or to text using the go/doc package; +see http://golang.org/pkg/go/doc/#ToHTML for the exact rules. See "Godoc: documenting Go code" for how to write good comments for godoc: http://golang.org/doc/articles/godoc_documenting_go_code.html