]> Sergey Matveev's repositories - btrtrc.git/commitdiff
Improve various File related doc comments
authorMatt Joiner <anacrolix@gmail.com>
Sun, 7 Jan 2018 00:57:02 +0000 (11:57 +1100)
committerMatt Joiner <anacrolix@gmail.com>
Sun, 7 Jan 2018 00:57:02 +0000 (11:57 +1100)
file.go

diff --git a/file.go b/file.go
index 19729b4cad8c074c7d39d2e327daa0f8547b15f2..9804b104e8a75262db44f01a7185f6ca76ae8c3b 100644 (file)
--- 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