summaryrefslogtreecommitdiff
path: root/src/pkg/html/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/pkg/html/doc.go')
-rw-r--r--src/pkg/html/doc.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/pkg/html/doc.go b/src/pkg/html/doc.go
index c5338d078..4f5dee72d 100644
--- a/src/pkg/html/doc.go
+++ b/src/pkg/html/doc.go
@@ -69,6 +69,9 @@ call to Next. For example, to extract an HTML page's anchor text:
}
}
+A Tokenizer typically skips over HTML comments. To return comment tokens, set
+Tokenizer.ReturnComments to true before looping over calls to Next.
+
Parsing is done by calling Parse with an io.Reader, which returns the root of
the parse tree (the document element) as a *Node. It is the caller's
responsibility to ensure that the Reader provides UTF-8 encoded HTML. For