From ba58e95f6bbb2f92f49de09abe2f85b2312fffc1 Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Thu, 15 May 2014 00:40:17 -0300 Subject: [PATCH] Package level comments --- beacon/doc.go | 2 ++ config/config.go | 1 + lamport/clock.go | 1 + logger/logger.go | 1 + model/doc.go | 2 ++ 5 files changed, 7 insertions(+) create mode 100644 beacon/doc.go create mode 100644 model/doc.go diff --git a/beacon/doc.go b/beacon/doc.go new file mode 100644 index 000000000..d7e6b1abc --- /dev/null +++ b/beacon/doc.go @@ -0,0 +1,2 @@ +// Package beacon implements an UDP broadcast beacon +package beacon diff --git a/config/config.go b/config/config.go index 9c7d3aa48..ff34b3def 100644 --- a/config/config.go +++ b/config/config.go @@ -1,3 +1,4 @@ +// Package config implements reading and writing of the syncthing configuration file. package config import ( diff --git a/lamport/clock.go b/lamport/clock.go index 9c652c04d..a67386167 100644 --- a/lamport/clock.go +++ b/lamport/clock.go @@ -1,3 +1,4 @@ +// Package lamport implements a simple Lamport Clock for versioning package lamport import "sync" diff --git a/logger/logger.go b/logger/logger.go index 2053e146b..ddd9a4146 100644 --- a/logger/logger.go +++ b/logger/logger.go @@ -1,3 +1,4 @@ +// Package logger implements a standardized logger with callback functionality package logger import ( diff --git a/model/doc.go b/model/doc.go new file mode 100644 index 000000000..ac2f62930 --- /dev/null +++ b/model/doc.go @@ -0,0 +1,2 @@ +// Package model implements repository abstraction and file pulling mechanisms +package model