Add missing package descriptions for GoDoc

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"