Browse Source

Package level comments

Jakob Borg 11 years ago
parent
commit
ba58e95f6b
5 changed files with 7 additions and 0 deletions
  1. 2 0
      beacon/doc.go
  2. 1 0
      config/config.go
  3. 1 0
      lamport/clock.go
  4. 1 0
      logger/logger.go
  5. 2 0
      model/doc.go

+ 2 - 0
beacon/doc.go

@@ -0,0 +1,2 @@
+// Package beacon implements an UDP broadcast beacon
+package beacon

+ 1 - 0
config/config.go

@@ -1,3 +1,4 @@
+// Package config implements reading and writing of the syncthing configuration file.
 package config
 
 import (

+ 1 - 0
lamport/clock.go

@@ -1,3 +1,4 @@
+// Package lamport implements a simple Lamport Clock for versioning
 package lamport
 
 import "sync"

+ 1 - 0
logger/logger.go

@@ -1,3 +1,4 @@
+// Package logger implements a standardized logger with callback functionality
 package logger
 
 import (

+ 2 - 0
model/doc.go

@@ -0,0 +1,2 @@
+// Package model implements repository abstraction and file pulling mechanisms
+package model