diff options
| -rw-r--r-- | database/doc.go | 10 | ||||
| -rw-r--r-- | http/client/doc.go | 10 | ||||
| -rw-r--r-- | http/cookie/doc.go | 10 | ||||
| -rw-r--r-- | http/request/doc.go | 2 | ||||
| -rw-r--r-- | http/route/doc.go | 10 | ||||
| -rw-r--r-- | integration/instapaper/doc.go | 10 | ||||
| -rw-r--r-- | integration/nunuxkeeper/doc.go | 10 | ||||
| -rw-r--r-- | integration/pinboard/doc.go | 10 | ||||
| -rw-r--r-- | integration/pocket/doc.go | 10 | ||||
| -rw-r--r-- | integration/wallabag/doc.go | 10 | ||||
| -rw-r--r-- | reader/atom/doc.go | 10 | ||||
| -rw-r--r-- | reader/date/doc.go | 10 | ||||
| -rw-r--r-- | reader/encoding/doc.go | 2 | ||||
| -rw-r--r-- | reader/feed/doc.go | 10 | ||||
| -rw-r--r-- | reader/icon/doc.go | 10 | ||||
| -rw-r--r-- | reader/json/doc.go | 10 | ||||
| -rw-r--r-- | reader/opml/doc.go | 10 | ||||
| -rw-r--r-- | reader/processor/doc.go | 10 | ||||
| -rw-r--r-- | reader/rdf/doc.go | 10 | ||||
| -rw-r--r-- | reader/readability/doc.go | 10 | ||||
| -rw-r--r-- | reader/rewrite/doc.go | 10 | ||||
| -rw-r--r-- | reader/rss/doc.go | 10 | ||||
| -rw-r--r-- | reader/sanitizer/doc.go | 10 | ||||
| -rw-r--r-- | reader/scraper/doc.go | 10 | ||||
| -rw-r--r-- | reader/subscription/doc.go | 10 | ||||
| -rw-r--r-- | timezone/doc.go | 10 | ||||
| -rw-r--r-- | ui/form/doc.go | 10 | ||||
| -rw-r--r-- | ui/session/doc.go | 10 | ||||
| -rw-r--r-- | ui/static/doc.go | 10 | ||||
| -rw-r--r-- | ui/view/doc.go | 10 |
30 files changed, 282 insertions, 2 deletions
diff --git a/database/doc.go b/database/doc.go new file mode 100644 index 0000000..9a2c5fc --- /dev/null +++ b/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" diff --git a/http/client/doc.go b/http/client/doc.go new file mode 100644 index 0000000..64015ca --- /dev/null +++ b/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" diff --git a/http/cookie/doc.go b/http/cookie/doc.go new file mode 100644 index 0000000..0efcc76 --- /dev/null +++ b/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" diff --git a/http/request/doc.go b/http/request/doc.go index 0c40fb8..8e30337 100644 --- a/http/request/doc.go +++ b/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" diff --git a/http/route/doc.go b/http/route/doc.go new file mode 100644 index 0000000..4b30497 --- /dev/null +++ b/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" diff --git a/integration/instapaper/doc.go b/integration/instapaper/doc.go new file mode 100644 index 0000000..d7c10e0 --- /dev/null +++ b/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" diff --git a/integration/nunuxkeeper/doc.go b/integration/nunuxkeeper/doc.go new file mode 100644 index 0000000..c697c70 --- /dev/null +++ b/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" diff --git a/integration/pinboard/doc.go b/integration/pinboard/doc.go new file mode 100644 index 0000000..49197d2 --- /dev/null +++ b/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" diff --git a/integration/pocket/doc.go b/integration/pocket/doc.go new file mode 100644 index 0000000..d644d6f --- /dev/null +++ b/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" diff --git a/integration/wallabag/doc.go b/integration/wallabag/doc.go new file mode 100644 index 0000000..d2ada9a --- /dev/null +++ b/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" 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" diff --git a/timezone/doc.go b/timezone/doc.go new file mode 100644 index 0000000..e666d2e --- /dev/null +++ b/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" diff --git a/ui/form/doc.go b/ui/form/doc.go new file mode 100644 index 0000000..d2f716f --- /dev/null +++ b/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" diff --git a/ui/session/doc.go b/ui/session/doc.go new file mode 100644 index 0000000..3e47bc6 --- /dev/null +++ b/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" diff --git a/ui/static/doc.go b/ui/static/doc.go new file mode 100644 index 0000000..d9aadf3 --- /dev/null +++ b/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" diff --git a/ui/view/doc.go b/ui/view/doc.go new file mode 100644 index 0000000..4ced5dc --- /dev/null +++ b/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" |