code review 903044: archive/tar: update documentation to match current codi...

src/pkg/archive/tar/reader.go

 // Copyright 2009 The Go Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
 package tar
 
 // TODO(dsymonds):
 //   - pax extensions
 
 import (
         "bytes"
         "io"
         "os"
         "strconv"
 )
 
 var (
         HeaderError os.Error = os.ErrorString("invalid tar header")
 )
 
 // A Reader provides sequential access to the contents of a tar archive.
 // A tar archive consists of a sequence of files.
 // The Next method advances to the next file in the archive (including the first),
 // and then it can be treated as an io.Reader to access the file's data.
 //
 // Example:
-//      tr := tar.NewReader(r);
+//      tr := tar.NewReader(r)
 //      for {
-//              hdr, err := tr.Next();
+//              hdr, err := tr.Next()
 //              if err != nil {
 //                      // handle error
 //              }
 //              if hdr == nil {
 //                      // end of tar archive
 //                      break
 //              }
-//              io.Copy(data, tr);
+//              io.Copy(data, tr)
 //      }
 type Reader struct {
         r   io.Reader
         err os.Error
         nb  int64 // number of unread bytes for current file entry
         pad int64 // amount of padding (ignored) after current file entry
 }
 
 // NewReader creates a new Reader reading from r.
 func NewReader(r io.Reader) *Reader { return &Reader{r: r} }
@@ skipping 169 matching lines @@
         }
         n, err = tr.r.Read(b)
         tr.nb -= int64(n)
 
         if err == os.EOF && tr.nb > 0 {
                 err = io.ErrUnexpectedEOF
         }
         tr.err = err
         return
 }