write a few package doc strings to improve look of godoc

blocks/blocks.go

@@ -1,3 +1,5 @@
+// package blocks contains the lowest level of ipfs data structures,
+// the raw block with a checksum.
 package blocks
 
 import (

blocks/bloom/filter.go

@@ -1,3 +1,4 @@
+// package bloom implements a simple bloom filter.
 package bloom
 
 import (

blocks/set/set.go

@@ -1,3 +1,4 @@
+// package set contains various different types of 'BlockSet's
 package set
 
 import (
@@ -7,6 +8,7 @@ import (
 
 var log = util.Logger("blockset")
 
+// BlockSet represents a mutable set of keyed blocks
 type BlockSet interface {
 	AddBlock(util.Key)
 	RemoveBlock(util.Key)

blockservice/blockservice.go

@@ -1,3 +1,6 @@
+// package blockservice implements a BlockService interface that provides
+// a single GetBlock/AddBlock interface that seamlessly retrieves data either
+// locally or from a remote peer through the exchange.
 package blockservice
 
 import (

blockstore/blockstore.go

@@ -1,3 +1,5 @@
+// package blockstore implements a thin wrapper over a datastore, giving a
+// clean interface for Getting and Putting block objects.
 package blockstore
 
 import (

config/config.go

@@ -1,3 +1,4 @@
+// package config implements the ipfs config file datastructures and utilities.
 package config
 
 import (

crypto/key.go

@@ -1,3 +1,6 @@
+// package crypto implements various cryptographic utilities used by ipfs.
+// This includes a Public and Private key interface and an RSA key implementation
+// that satisfies it.
 package crypto
 
 import (

crypto/spipe/handshake.go

@@ -1,5 +1,4 @@
-// Package spipe handles establishing secure communication between two peers.
+// package spipe handles establishing secure communication between two peers.
-
 package spipe
 
 import (

diagnostics/diag.go

@@ -1,3 +1,6 @@
+// package diagnostics implements a network diagnostics service that
+// allows a request to traverse the network and gather information
+// on every node connected to it.
 package diagnostics
 
 import (

fuse/ipns/ipns_unix.go

@@ -1,3 +1,5 @@
+// package fuse/ipns implements a fuse filesystem that interfaces
+// with ipns, the naming system for ipfs.
 package ipns
 
 import (

fuse/readonly/readonly_unix.go

@@ -1,7 +1,7 @@
-// A Go mirror of libfuse's hello.c
-
 // +build linux darwin freebsd
 
+// package fuse/readonly implements a fuse filesystem to access files
+// stored inside of ipfs.
 package readonly
 
 import (

importer/chunk/splitting.go

@@ -1,3 +1,4 @@
+// package chunk implements streaming block splitters
 package chunk
 
 import (

importer/importer.go

@@ -1,3 +1,5 @@
+// package importer implements utilities used to create ipfs DAGs from files
+// and readers
 package importer
 
 import (

merkledag/merkledag.go

@@ -1,3 +1,4 @@
+// package merkledag implements the ipfs Merkle DAG datastructures.
 package merkledag
 
 import (

path/path.go

@@ -1,3 +1,4 @@
+// package path implements utilities for resolving paths within ipfs.
 package path
 
 import (

peer/peer.go

@@ -1,3 +1,4 @@
+// package peer implements an object used to represent peers in the ipfs network.
 package peer
 
 import (

routing/dht/dht.go

@@ -1,3 +1,5 @@
+// package dht implements a distributed hash table that satisfies the ipfs routing
+// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
 package dht
 
 import (

routing/kbucket/bucket.go

@@ -1,4 +1,4 @@
-package dht
+package kbucket
 
 import (
 	"container/list"

routing/kbucket/table.go

@@ -1,4 +1,5 @@
-package dht
+// package kbucket implements a kademlia 'k-bucket' routing table.
+package kbucket
 
 import (
 	"container/list"

routing/kbucket/table_test.go

@@ -1,4 +1,4 @@
-package dht
+package kbucket
 
 import (
 	crand "crypto/rand"

routing/kbucket/util.go

@@ -1,4 +1,4 @@
-package dht
+package kbucket
 
 import (
 	"bytes"

routing/routing.go

@@ -1,3 +1,4 @@
+// package routing defines the interface for a routing system used by ipfs.
 package routing
 
 import (

util/util.go

@@ -1,3 +1,5 @@
+// package util implements various utility functions used within ipfs
+// that do not currently have a better place to live.
 package util
 
 import (