From: Matt Joiner <anacrolix@gmail.com>
Date: Sun, 7 Jan 2018 00:57:02 +0000 (+1100)
Subject: Improve various File related doc comments
X-Git-Tag: v1.0.0~294
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=7f482461195ebc2c552c8ad3be6337f31b89b80c;p=btrtrc.git

Improve various File related doc comments
---

diff --git a/file.go b/file.go
index 19729b4c..9804b104 100644
--- a/file.go
+++ b/file.go
@@ -19,19 +19,22 @@ func (f *File) Torrent() *Torrent {
 	return f.t
 }
 
-// Data for this file begins this far into the torrent.
+// Data for this file begins this many bytes into the Torrent.
 func (f *File) Offset() int64 {
 	return f.offset
 }
 
+// The FileInfo from the metainfo.Info to which this file corresponds.
 func (f File) FileInfo() metainfo.FileInfo {
 	return f.fi
 }
 
+// The file's path components joined by '/'.
 func (f File) Path() string {
 	return f.path
 }
 
+// The file's length in bytes.
 func (f *File) Length() int64 {
 	return f.length
 }
@@ -47,6 +50,7 @@ func (f *File) DisplayPath() string {
 
 }
 
+// The download status of a piece that comprises part of a File.
 type FilePieceState struct {
 	Bytes int64 // Bytes within the piece that are part of this File.
 	PieceState