1
0
mirror of https://github.com/golang/go synced 2024-11-19 21:34:45 -07:00
go/lib/godoc/package.txt
Robert Griesemer 38e7fddc21 Show BUG comments in godoc:
ast.go:
- rename Comments -> CommentGroup (less confusion)
- change all comments/docs to be *CommentGroup

filter.go:
- do not remove unassociated comments from program as part
  of export filtering (they are needed by doc.go for BUG comments)

scanner.go:
- exclude '\n' from //-style comments

parser.go:
- rewrote collection of comments: now all collected comments
  are *ast.CommentGroups
- clarified distinction between leading and trailing comments
- fixed a bug in comment collection (parseGenDecl);
  corresponding test case is in printer/testdata
- extra documentation

doc.go:
- collect BUG comments
- corresponding fix for parser bug in comment collection

comment.go:
- simplified regex

printer.go:
- adjust comment printing to new representation

printer_test.go, testdata/*:
- enable printing of doc comments
- extended tests

package.html, package.txt:
- added Bugs section

gofmt:
- enable printing of doc comments

R=rsc
DELTA=339  (126 added, 38 deleted, 175 changed)
OCL=31403
CL=31416
2009-07-09 16:38:17 -07:00

70 lines
648 B
Plaintext

{.section Dirs}
SUBDIRECTORIES
{.repeated section @}
{Name}
{.end}
{.end}
{.section PDoc}
PACKAGE
package {PackageName}
import "{ImportPath}"
{.section Doc}
{@}
{.end}
{.section Consts}
CONSTANTS
{.repeated section @}
{Decl}
{Doc}
{.end}
{.end}
{.section Vars}
VARIABLES
{.repeated section @}
{Decl}
{Doc}
{.end}
{.end}
{.section Funcs}
FUNCTIONS
{.repeated section @}
{Decl}
{Doc}
{.end}
{.end}
{.section Types}
TYPES
{.repeated section @}
{Decl}
{Doc}
{.repeated section Factories}
{Decl}
{Doc}
{.end}
{.repeated section Methods}
{Decl}
{Doc}
{.end}
{.end}
{.end}
{.section Bugs}
BUGS
{.repeated section @}
{@}
{.end}
{.end}
{.end}