]> Cypherpunks repositories - gostls13.git/commitdiff
encoding/xml: fix documentation for Decoder.Skip
authorRob Pike <r@golang.org>
Tue, 7 Feb 2012 05:15:35 +0000 (16:15 +1100)
committerRob Pike <r@golang.org>
Tue, 7 Feb 2012 05:15:35 +0000 (16:15 +1100)
Fixes #2850.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5645043

src/pkg/encoding/xml/read.go

index 6a8f5afee7e55ce83fa32ba1ea203060531566be..bde875a012303ab840bbfb2ddc2d83eeb98b3c49 100644 (file)
@@ -542,10 +542,12 @@ Loop:
        panic("unreachable")
 }
 
-// Have already read a start element.
-// Read tokens until we find the end element.
-// Token is taking care of making sure the
-// end element matches the start element we saw.
+// Skip reads tokens until it has consumed the end element
+// matching the most recent start element already consumed.
+// It recurs if it encounters a start element, so it can be used to
+// skip nested structures.
+// It returns nil if it finds an end element matching the start
+// element; otherwise it returns an error describing the problem.
 func (d *Decoder) Skip() error {
        for {
                tok, err := d.Token()