Documentation.

License: MIT Signed-off-by: Kevin Atkinson <k@kevina.org>
ipfs · Oct 19, 2017 · 6d1d38c · 6d1d38c
1 parent 253b379
commit 6d1d38c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 1 deletion.
diff --git a/merkledag/node.go b/merkledag/node.go
@@ -42,7 +42,10 @@ var v1CidPrefix = cid.Prefix{
 	Version:  1,
 }
 
+// V0CidPrefix returns a prefix for CIDv0
 func V0CidPrefix() cid.Prefix { return v0CidPrefix }
+
+// V1CidPrefix returns a prefix for CIDv1 with the default settings
 func V1CidPrefix() cid.Prefix { return v1CidPrefix }
 
 // PrefixForCidVersion returns the Protobuf prefix for a given CID version

diff --git a/unixfs/hamt/hamt.go b/unixfs/hamt/hamt.go
@@ -131,7 +131,7 @@ func (ds *HamtShard) SetPrefix(prefix *cid.Prefix) {
 	ds.prefix = prefix
 }
 
-// GetPrefix gets the CID Prefix, may be nil if unset
+// Prefix gets the CID Prefix, may be nil if unset
 func (ds *HamtShard) Prefix() *cid.Prefix {
 	return ds.prefix
 }

diff --git a/unixfs/io/dirbuilder.go b/unixfs/io/dirbuilder.go
@@ -194,6 +194,7 @@ func (d *Directory) GetNode() (node.Node, error) {
 	return d.shard.Node()
 }
 
+// GetPrefix returns the CID Prefix used
 func (d *Directory) GetPrefix() *cid.Prefix {
 	if d.shard == nil {
 		return &d.dirnode.Prefix

diff --git a/unixfs/test/utils.go b/unixfs/test/utils.go
@@ -31,6 +31,7 @@ func GetDAGServ() mdag.DAGService {
 	return mdagmock.Mock()
 }
 
+// NodeOpts is used by GetNode, GetEmptyNode and GetRandomNode
 type NodeOpts struct {
 	Prefix cid.Prefix
 	// ForceRawLeaves if true will force the use of raw leaves