From 446b21c5689120f0f7a378d78c32c3e9de60f30a Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Wed, 12 Mar 2014 06:32:26 +0100 Subject: [PATCH] Package descriptions for godoc --- auto/doc.go | 2 ++ buffers/buffers.go | 1 + cid/cid.go | 1 + discover/doc.go | 2 ++ files/set.go | 1 + protocol/doc.go | 2 ++ scanner/doc.go | 2 ++ xdr/doc.go | 2 ++ 8 files changed, 13 insertions(+) create mode 100644 auto/doc.go create mode 100644 discover/doc.go create mode 100644 protocol/doc.go create mode 100644 scanner/doc.go create mode 100644 xdr/doc.go diff --git a/auto/doc.go b/auto/doc.go new file mode 100644 index 000000000..66c06cbb1 --- /dev/null +++ b/auto/doc.go @@ -0,0 +1,2 @@ +// Package auto contains auto generated files for web assets. +package auto diff --git a/buffers/buffers.go b/buffers/buffers.go index 3112264b9..d67160ac3 100644 --- a/buffers/buffers.go +++ b/buffers/buffers.go @@ -1,3 +1,4 @@ +// Package buffers manages a set of reusable byte buffers. package buffers const ( diff --git a/cid/cid.go b/cid/cid.go index 1fd343cc6..3a3727dc5 100644 --- a/cid/cid.go +++ b/cid/cid.go @@ -1,3 +1,4 @@ +// Package cid provides a manager for mappings between node ID:s and connection ID:s. package cid type Map struct { diff --git a/discover/doc.go b/discover/doc.go new file mode 100644 index 000000000..f4ba42f4c --- /dev/null +++ b/discover/doc.go @@ -0,0 +1,2 @@ +// Package discover implements the node discovery protocol. +package discover diff --git a/files/set.go b/files/set.go index 3d2af910f..8da72b8f1 100644 --- a/files/set.go +++ b/files/set.go @@ -1,3 +1,4 @@ +// Package fileset provides a set type to track local/remote files with newness checks. package fileset import "sync" diff --git a/protocol/doc.go b/protocol/doc.go new file mode 100644 index 000000000..f9bf7fa6e --- /dev/null +++ b/protocol/doc.go @@ -0,0 +1,2 @@ +// Package protocol implements the Block Exchange Protocol. +package protocol diff --git a/scanner/doc.go b/scanner/doc.go new file mode 100644 index 000000000..a9c1b1c34 --- /dev/null +++ b/scanner/doc.go @@ -0,0 +1,2 @@ +// Package scanner implements a file system scanner and hasher. +package scanner diff --git a/xdr/doc.go b/xdr/doc.go new file mode 100644 index 000000000..caa570b28 --- /dev/null +++ b/xdr/doc.go @@ -0,0 +1,2 @@ +// Package xdr implements an XDR (RFC 4506) encoder/decoder. +package xdr