Add missing package descriptions for GoDoc

15 files changed, 141 insertions, 1 deletions

diff --git a/reader/atom/doc.go b/reader/atom/doc.go
new file mode 100644
index 0000000..d0b231a
--- /dev/null
+++ b/reader/atom/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package atom provides an Atom feed parser.
+
+*/
+package atom // import "miniflux.app/reader/atom"
diff --git a/reader/date/doc.go b/reader/date/doc.go
new file mode 100644
index 0000000..ef0fdaa
--- /dev/null
+++ b/reader/date/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package date provides a feed date parser.
+
+*/
+package date // import "miniflux.app/reader/date"
diff --git a/reader/encoding/doc.go b/reader/encoding/doc.go
index 8498cf3..f301d04 100644
--- a/reader/encoding/doc.go
+++ b/reader/encoding/doc.go
@@ -4,7 +4,7 @@
 
 /*
 
-Package encoding handles workarounds to deal with encoding edge cases found into the wild.
+Package encoding handles workarounds to deal with encoding edge cases found into feeds.
 
 */
 package encoding // import "miniflux.app/reader/encoding"
diff --git a/reader/feed/doc.go b/reader/feed/doc.go
new file mode 100644
index 0000000..de2e5ab
--- /dev/null
+++ b/reader/feed/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package feed provides a generic feed parser that abstracts all different formats.
+
+*/
+package feed // import "miniflux.app/reader/feed"
diff --git a/reader/icon/doc.go b/reader/icon/doc.go
new file mode 100644
index 0000000..1416291
--- /dev/null
+++ b/reader/icon/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package icon provides all the logic to download website icons.
+
+*/
+package icon // import "miniflux.app/reader/icon"
diff --git a/reader/json/doc.go b/reader/json/doc.go
new file mode 100644
index 0000000..7e678e4
--- /dev/null
+++ b/reader/json/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package json provides a JSON feed parser.
+
+*/
+package json // import "miniflux.app/reader/json"
diff --git a/reader/opml/doc.go b/reader/opml/doc.go
new file mode 100644
index 0000000..5c94936
--- /dev/null
+++ b/reader/opml/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package opml provides an OPML parser and writer.
+
+*/
+package opml // import "miniflux.app/reader/opml"
diff --git a/reader/processor/doc.go b/reader/processor/doc.go
new file mode 100644
index 0000000..f0e7fd4
--- /dev/null
+++ b/reader/processor/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package processor handles the logic to manipulate feed contents.
+
+*/
+package processor // import "miniflux.app/reader/processor"
diff --git a/reader/rdf/doc.go b/reader/rdf/doc.go
new file mode 100644
index 0000000..5734afe
--- /dev/null
+++ b/reader/rdf/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package rdf provides a RDF feed parser.
+
+*/
+package rdf // import "miniflux.app/reader/rdf"
diff --git a/reader/readability/doc.go b/reader/readability/doc.go
new file mode 100644
index 0000000..c414156
--- /dev/null
+++ b/reader/readability/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package readability implements a web page scraper that returns only relevant content.
+
+*/
+package readability // import "miniflux.app/reader/readability"
diff --git a/reader/rewrite/doc.go b/reader/rewrite/doc.go
new file mode 100644
index 0000000..ba44b8e
--- /dev/null
+++ b/reader/rewrite/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package rewrite provides functions to manipulate feed contents.
+
+*/
+package rewrite // import "miniflux.app/reader/rewrite"
diff --git a/reader/rss/doc.go b/reader/rss/doc.go
new file mode 100644
index 0000000..d13b31e
--- /dev/null
+++ b/reader/rss/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package rss provides a RSS feed parser.
+
+*/
+package rss // import "miniflux.app/reader/rss"
diff --git a/reader/sanitizer/doc.go b/reader/sanitizer/doc.go
new file mode 100644
index 0000000..89dfe62
--- /dev/null
+++ b/reader/sanitizer/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package sanitizer implements a HTML sanitizer that removes unsafe elements.
+
+*/
+package sanitizer // import "miniflux.app/reader/sanitizer"
diff --git a/reader/scraper/doc.go b/reader/scraper/doc.go
new file mode 100644
index 0000000..ed7ff7e
--- /dev/null
+++ b/reader/scraper/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package scraper implements a web page crawler.
+
+*/
+package scraper // import "miniflux.app/reader/scraper"
diff --git a/reader/subscription/doc.go b/reader/subscription/doc.go
new file mode 100644
index 0000000..ebeee1c
--- /dev/null
+++ b/reader/subscription/doc.go
@@ -0,0 +1,10 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+/*
+
+Package subscription implements the logic to find subscriptions on a website.
+
+*/
+package subscription // import "miniflux.app/reader/subscription"