markdown.go: document Formatter

This commit is contained in:
Michael Teichgräber 2012-09-01 00:25:43 +02:00
parent 38ff54e038
commit ab2227c41c

View File

@ -62,6 +62,10 @@ func NewParser(x *Extensions) (p *Parser) {
return return
} }
// A Formatter is called repeatedly, one Markdown block at a time,
// while the document is parsed. At the end of a document the Finish
// method is called, which may, for example, print footnotes.
// A Formatter can be reused.
type Formatter interface { type Formatter interface {
FormatBlock(*element) FormatBlock(*element)
Finish() Finish()