From f269ad2ff4d3014bdf099430e08543a3f695cf1e Mon Sep 17 00:00:00 2001
From: Dave Collins <davec@conformal.com>
Date: Fri, 9 Aug 2013 16:02:47 -0500
Subject: [PATCH] Comment the logClosure code.

---
 peer.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/peer.go b/peer.go
index d0e93fb0..0fdbf3bb 100644
--- a/peer.go
+++ b/peer.go
@@ -788,12 +788,18 @@ func newPeer(s *server, conn net.Conn, inbound bool, persistent bool) *peer {
 	return &p
 }
 
+// logClosure is used to provide a closure over expensive logging operations
+// so don't have to be performed when the logging level doesn't warrant it.
 type logClosure func() string
 
+// String invokes the underlying function and returns the result.
 func (c logClosure) String() string {
 	return c()
 }
 
+// newLogClosure returns a new closure over a function that returns a string
+// which itself provides a Stringer interface so that it can be used with the
+// logging system.
 func newLogClosure(c func() string) logClosure {
 	return logClosure(c)
 }