Browse Source

Add missing package descriptions for GoDoc

Frédéric Guillot 10 months ago
parent
commit
9dc38a0803

+ 10 - 0
database/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 database provides functions related to the database connection.
+
+*/
+package database // import "miniflux.app/database"

+ 10 - 0
http/client/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 client provides an HTTP client builder.
+
+*/
+package client // import "miniflux.app/http/client"

+ 10 - 0
http/cookie/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 cookie provides functions to build cookies.
+
+*/
+package cookie // import "miniflux.app/http/cookie"

+ 1 - 1
http/request/doc.go

@@ -4,7 +4,7 @@
 
 /*
 
-Package request holds helper functions regarding the HTTP request.
+Package request contains helper functions to work with the HTTP request.
 
 */
 package request // import "miniflux.app/http/request"

+ 10 - 0
http/route/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 route contains helper functions to work with defined routes.
+
+*/
+package route // import "miniflux.app/http/route"

+ 10 - 0
integration/instapaper/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 instapaper provides an integration with Instapaper.
+
+*/
+package instapaper // import "miniflux.app/integration/instapaper"

+ 10 - 0
integration/nunuxkeeper/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 nunuxkeeper provides an integration with the Nunux Keeper application.
+
+*/
+package nunuxkeeper // import "miniflux.app/integration/nunuxkeeper"

+ 10 - 0
integration/pinboard/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 pinboard provides an integration with Pinboard.
+
+*/
+package pinboard // import "miniflux.app/integration/pinboard"

+ 10 - 0
integration/pocket/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 pocket provides an integration with Pocket.
+
+*/
+package pocket // import "miniflux.app/integration/pocket"

+ 10 - 0
integration/wallabag/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 wallabag provides an integration with the Wallabag application.
+
+*/
+package wallabag // import "miniflux.app/integration/wallabag"

+ 10 - 0
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"

+ 10 - 0
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"

+ 1 - 1
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
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"

+ 10 - 0
timezone/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 timezone contains helper functions to work with timezones.
+
+*/
+package timezone // import "miniflux.app/timezone"

+ 10 - 0
ui/form/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 form handles HTML form validation and serialization.
+
+*/
+package form // import "miniflux.app/ui/form"

+ 10 - 0
ui/session/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 session provides helper functions to work with the user session.
+
+*/
+package session // import "miniflux.app/ui/session"

+ 10 - 0
ui/static/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 static contains assets for the user interface.
+
+*/
+package static // import "miniflux.app/ui/static"

+ 10 - 0
ui/view/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 view handles template parameters.
+
+*/
+package view // import "miniflux.app/ui/view"