From ab2227c41c9aaa806f4558838adffaa2794291c9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20Teichgr=C3=A4ber?= <mt@ib.wmipf.de>
Date: Sat, 1 Sep 2012 00:25:43 +0200
Subject: [PATCH] markdown.go: document Formatter

---
 markdown.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/markdown.go b/markdown.go
index bbc3db5..555ec9e 100644
--- a/markdown.go
+++ b/markdown.go
@@ -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()