Permalink
Browse files

markdown.go: document Formatter

  • Loading branch information...
1 parent 38ff54e commit ab2227c41c9aaa806f4558838adffaa2794291c9 @knieriem committed Aug 31, 2012
Showing with 4 additions and 0 deletions.
  1. +4 −0 markdown.go
View
@@ -62,6 +62,10 @@ func NewParser(x *Extensions) (p *Parser) {
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 {
FormatBlock(*element)
Finish()

0 comments on commit ab2227c

Please sign in to comment.