From 8d94d5532074396d708547ba6755aa29aa0d6f10 Mon Sep 17 00:00:00 2001 From: Marius Date: Fri, 18 Dec 2015 23:24:12 +0100 Subject: [PATCH] Add package descriptions for documentation --- filestore/filestore.go | 2 ++ handler.go | 1 + limitedstore/limitedstore.go | 4 +++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/filestore/filestore.go b/filestore/filestore.go index a3a80b6..e524724 100644 --- a/filestore/filestore.go +++ b/filestore/filestore.go @@ -1,3 +1,5 @@ +// Package filestore provide a storage backend based on the local file system. +// // FileStore is a storage backend used as a tusd.DataStore in tusd.NewHandler. // It stores the uploads in a directory specified in two different files: The // `[id].info` files are used to store the fileinfo in JSON format. The diff --git a/handler.go b/handler.go index 2a8a9ba..aafb1e2 100644 --- a/handler.go +++ b/handler.go @@ -1,3 +1,4 @@ +// Package tusd provides ways to accept tusd calls using HTTP. package tusd import ( diff --git a/limitedstore/limitedstore.go b/limitedstore/limitedstore.go index c77ad5f..7b6da8c 100644 --- a/limitedstore/limitedstore.go +++ b/limitedstore/limitedstore.go @@ -1,4 +1,6 @@ -// Package limitedstore implements a simple wrapper around existing +// Package limitedstore provides a storage with a limited space. +// +// This goal is achieved by using a simple wrapper around existing // datastores (tusd.DataStore) while limiting the used storage size. // It will start terminating existing uploads if not enough space is left in // order to create a new upload.