From 1cd9b6805da0979dde15f43507013eb8044c2d20 Mon Sep 17 00:00:00 2001 From: Markus Richter Date: Mon, 8 Jan 2018 20:20:51 +0000 Subject: [PATCH] docs: document packages and fix typo --- addrmgr/doc.go | 2 +- bloom/doc.go | 8 ++++++++ limits/doc.go | 8 ++++++++ mempool/doc.go | 8 ++++++++ 4 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 bloom/doc.go create mode 100644 limits/doc.go create mode 100644 mempool/doc.go diff --git a/addrmgr/doc.go b/addrmgr/doc.go index 98d1408a..149a1f20 100644 --- a/addrmgr/doc.go +++ b/addrmgr/doc.go @@ -10,7 +10,7 @@ Address Manager Overview In order maintain the peer-to-peer Decred network, there needs to be a source of addresses to connect to as nodes come and go. The Decred protocol provides -a the getaddr and addr messages to allow peers to communicate known addresses +the getaddr and addr messages to allow peers to communicate known addresses with each other. However, there needs to a mechanism to store those results and select peers from them. It is also important to note that remote peers can't be trusted to send valid peers nor attempt to provide you with only peers they diff --git a/bloom/doc.go b/bloom/doc.go new file mode 100644 index 00000000..5acd051e --- /dev/null +++ b/bloom/doc.go @@ -0,0 +1,8 @@ +// Copyright (c) 2018 The Decred developers +// Use of this source code is governed by an ISC +// license that can be found in the LICENSE file. + +/* +Package bloom provides an API for dealing with decred-specific bloom filters. +*/ +package bloom diff --git a/limits/doc.go b/limits/doc.go new file mode 100644 index 00000000..4addb072 --- /dev/null +++ b/limits/doc.go @@ -0,0 +1,8 @@ +// Copyright (c) 2018 The Decred developers +// Use of this source code is governed by an ISC +// license that can be found in the LICENSE file. + +/* +Package limits allows to raises some process limits. +*/ +package limits diff --git a/mempool/doc.go b/mempool/doc.go new file mode 100644 index 00000000..65ac5c43 --- /dev/null +++ b/mempool/doc.go @@ -0,0 +1,8 @@ +// Copyright (c) 2018 The Decred developers +// Use of this source code is governed by an ISC +// license that can be found in the LICENSE file. + +/* +Package mempool implements a memory pool to store (unconfirmed) transactions. +*/ +package mempool