]> Sergey Matveev's repositories - btrtrc.git/commitdiff
Add Builder docs. A bit shallow for now, but whatever.
authornsf <no.smile.face@gmail.com>
Thu, 5 Jul 2012 16:47:14 +0000 (22:47 +0600)
committernsf <no.smile.face@gmail.com>
Thu, 5 Jul 2012 16:47:14 +0000 (22:47 +0600)
torrent/builder.go

index 95ed88168e0086d6417f375c8053038243360ef9..6dd6eb6b8dfad967009f4d188b4ed4b0b69d9b58 100644 (file)
@@ -12,6 +12,9 @@ import (
        "os"
 )
 
+// The Builder type is responsible for .torrent files construction. Just
+// instantiate it, call necessary methods and then call the .Build method. While
+// waiting for completion you can use 'status' channel to get status reports.
 type Builder struct {
        filesmap      map[string]bool
        files         []file