[go-nuts] Reference about comments transformed to HTML

On Saturday, May 4, 2013 11:12:25 AM UTC-4, Archos wrote:

Is there any reference of how the comments are converted to HTML at using
godoc?

You might try ~/go/src/cmd/godoc/format.go if you have source installed.
FormatText() has some context info but I suspect you'll find it moderately
difficult to patch anything new in without understanding the command pretty
well. It doesn't look "excessively hard" but neither is it trivial.

On Sat, May 4, 2013 at 11:43 PM, Archos wrote:

Hote, like you say the code is in
http://golang.org/src/cmd/godoc/format.go

But I would like that were added documentation (in the wiki or in
http://golang.org/ref/) about how it's transformed, e.g. with 4 spaces at
the beginning of the line, does this...

On Sat, May 4, 2013 at 11:43 PM, Archos <[email protected] <javascript:>>wrote:
From http://golang.org/doc/articles/godoc_documenting_go_code.html:
There are a few formatting rules that Godoc uses when converting comments
to HTML:
- Subsequent lines of text are considered part of the same paragraph; you
must leave a blank line to separate paragraphs.
- Pre-formatted text must be indented relative to the surrounding comment
text (see gob's doc.go for an example).
- URLs will be converted to HTML links; no special markup is necessary.
Note that none of these rules requires you to do anything out of the
ordinary.

On Sun, May 5, 2013 at 11:18 PM, Archos wrote:

But it is incomplete, i.e. wathcing the output "http://golang.org/cmd/go/"
from "http://golang.org/src/cmd/go/doc.go",
how are added the titles such as "Compile packages and dependencies"? I
would say that with 2 blank lines to separate paragraphas. And it could
have other more rule that I've lost.