write a few package doc strings to improve look of godoc
Jeromy committed
Nov 8, 2014 at 13:43 UTC
4f083d54d687138ecaa51b827ea73d79c6a49b77
23 files changed
+38
-8
blocks/blocks.go
+2
@@ -1,3 +1,5 @@
1
+// package blocks contains the lowest level of ipfs data structures,
2
+// the raw block with a checksum.
3
package blocks
4
5
import (
blocks/bloom/filter.go
+1
@@ -1,3 +1,4 @@
1
+// package bloom implements a simple bloom filter.
2
package bloom
3
4
import (
blocks/set/set.go
+2
@@ -1,3 +1,4 @@
1
+// package set contains various different types of 'BlockSet's
2
package set
3
4
import (
@@ -7,6 +8,7 @@ import (
8
9
var log = util.Logger("blockset")
10
11
+// BlockSet represents a mutable set of keyed blocks
12
type BlockSet interface {
13
AddBlock(util.Key)
14
RemoveBlock(util.Key)
blockservice/blockservice.go
+3
@@ -1,3 +1,6 @@
1
+// package blockservice implements a BlockService interface that provides
2
+// a single GetBlock/AddBlock interface that seamlessly retrieves data either
3
+// locally or from a remote peer through the exchange.
4
package blockservice
5
6
import (
blockstore/blockstore.go
+2
@@ -1,3 +1,5 @@
1
+// package blockstore implements a thin wrapper over a datastore, giving a
2
+// clean interface for Getting and Putting block objects.
3
package blockstore
4
5
import (
config/config.go
+1
@@ -1,3 +1,4 @@
1
+// package config implements the ipfs config file datastructures and utilities.
2
package config
3
4
import (
crypto/key.go
+3
@@ -1,3 +1,6 @@
1
+// package crypto implements various cryptographic utilities used by ipfs.
2
+// This includes a Public and Private key interface and an RSA key implementation
3
+// that satisfies it.
4
package crypto
5
6
import (
crypto/spipe/handshake.go
+1
-2
@@ -1,5 +1,4 @@
1
-// Package spipe handles establishing secure communication between two peers.
2
-
1
+// package spipe handles establishing secure communication between two peers.
2
package spipe
3
4
import (
diagnostics/diag.go
+3
@@ -1,3 +1,6 @@
1
+// package diagnostics implements a network diagnostics service that
2
+// allows a request to traverse the network and gather information
3
+// on every node connected to it.
4
package diagnostics
5
6
import (
fuse/ipns/ipns_unix.go
+2
@@ -1,3 +1,5 @@
1
+// package fuse/ipns implements a fuse filesystem that interfaces
2
+// with ipns, the naming system for ipfs.
3
package ipns
4
5
import (
fuse/readonly/readonly_unix.go
+2
-2
@@ -1,7 +1,7 @@
1
-// A Go mirror of libfuse's hello.c
2
-
1
// +build linux darwin freebsd
2
3
+// package fuse/readonly implements a fuse filesystem to access files
4
+// stored inside of ipfs.
5
package readonly
6
7
import (
importer/chunk/splitting.go
+1
@@ -1,3 +1,4 @@
1
+// package chunk implements streaming block splitters
2
package chunk
3
4
import (
importer/importer.go
+2
@@ -1,3 +1,5 @@
1
+// package importer implements utilities used to create ipfs DAGs from files
2
+// and readers
3
package importer
4
5
import (
merkledag/merkledag.go
+1
@@ -1,3 +1,4 @@
1
+// package merkledag implements the ipfs Merkle DAG datastructures.
2
package merkledag
3
4
import (
path/path.go
+1
@@ -1,3 +1,4 @@
1
+// package path implements utilities for resolving paths within ipfs.
2
package path
3
4
import (
peer/peer.go
+1
@@ -1,3 +1,4 @@
1
+// package peer implements an object used to represent peers in the ipfs network.
2
package peer
3
4
import (
routing/dht/dht.go
+2
@@ -1,3 +1,5 @@
1
+// package dht implements a distributed hash table that satisfies the ipfs routing
2
+// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
3
package dht
4
5
import (
routing/kbucket/bucket.go
+1
-1
@@ -1,4 +1,4 @@
1
-package dht
1
+package kbucket
2
3
import (
4
"container/list"
routing/kbucket/table.go
+2
-1
@@ -1,4 +1,5 @@
1
-package dht
1
+// package kbucket implements a kademlia 'k-bucket' routing table.
2
+package kbucket
3
4
import (
5
"container/list"
routing/kbucket/table_test.go
+1
-1
@@ -1,4 +1,4 @@
1
-package dht
1
+package kbucket
2
3
import (
4
crand "crypto/rand"
routing/kbucket/util.go
+1
-1
@@ -1,4 +1,4 @@
1
-package dht
1
+package kbucket
2
3
import (
4
"bytes"
routing/routing.go
+1
@@ -1,3 +1,4 @@
1
+// package routing defines the interface for a routing system used by ipfs.
2
package routing
3
4
import (
util/util.go
+2
@@ -1,3 +1,5 @@
1
+// package util implements various utility functions used within ipfs
2
+// that do not currently have a better place to live.
3
package util
4
5
import (