luisgulo/photoprism
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Backend: Update Go package descriptions to improve generated docs

Browse source 
see https://pkg.go.dev/github.com/photoprism/photoprism
This commit is contained in:
Michael Mayer 2022-04-25 09:53:55 +02:00
parent 42e37fa862
commit e59041e93f
27 changed files with 92 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
internal/acl/acl.go
View file

@ -1,6 +1,6 @@
/*
Package acl contains PhotoPrism's access control lists for authorizing user actions.
Package acl provides access control lists for authorization checking of user actions.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

2
internal/api/api.go
View file

@ -1,6 +1,6 @@
/*
Package api contains PhotoPrism REST API handlers.
Package api provides REST API request handlers.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

8
internal/api/doc.go
View file

@ -1,8 +0,0 @@
/*
Package api contains REST request handlers used by the server package.
Additional information concerning the API can be found in our Developer Guide:
https://github.com/photoprism/photoprism/wiki/REST-API
*/
package api

2
internal/auto/auto.go
View file

@ -1,6 +1,6 @@
/*
Package auto contains index & import background workers.
Package auto provides workers for background indexing and import operations.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

4
internal/classify/gen.go
View file

@ -82,9 +82,11 @@ func main() {
})
}
var packageTemplate = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
var packageTemplate = template.Must(template.New("").Parse(`
package classify
// Generated code, do not edit.
var Rules = LabelRules{
{{- range $key, $value := .Rules }}
{{ printf "%q" $key }}: {

3
internal/classify/rules.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package classify
// Generated code, do not edit.
var Rules = LabelRules{
"abacus": {
Label: "",

2
internal/config/about.go
View file

@ -1,6 +1,6 @@
/*
Package config contains CLI config related config functionality.
Package config provides global options, command-line flags, and user settings.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

2
internal/hub/hub.go
View file

@ -1,6 +1,6 @@
/*
Package hub contains backend api config & clients.
Package hub provides privacy-preserving reverse geocoding and other backend services.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

2
internal/i18n/i18n.go
View file

@ -1,6 +1,6 @@
/*
Package i18n contains PhotoPrism status and error message strings.
Package i18n provides translatable notification and error messages.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

3
internal/maps/countries.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package maps
// Generated code, do not edit.
var CountryNames = map[string]string{
"af": "Afghanistan",
"ax": "Åland Islands",

4
internal/maps/gen.go
View file

@ -50,9 +50,11 @@ func main() {
})
}
var packageTemplate = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
var packageTemplate = template.Must(template.New("").Parse(`
package maps
// Generated code, do not edit.
var CountryNames = map[string]string{
{{- range .Countries }}
{{ printf "%q" .Code }}: {{ printf "%q" .Name }},

2
internal/meta/meta.go
View file

@ -1,6 +1,6 @@
/*
Package meta encapsulates image metadata decoding and conversion to/from XMP and Exif.
Package meta provides XMP and Exif metadata parsing and normalization.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

3
internal/migrate/dialect_mysql.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package migrate
// Generated code, do not edit.
var DialectMySQL = Migrations{
{
ID: "20211121-094727",

3
internal/migrate/dialect_sqlite3.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package migrate
// Generated code, do not edit.
var DialectSQLite3 = Migrations{
{
ID: "20211121-094727",

4
internal/migrate/generate.go
View file

@ -98,9 +98,11 @@ func main() {
gen_migrations("SQLite3")
}
var migrationsTemplate = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
var migrationsTemplate = template.Must(template.New("").Parse(`
package migrate
// Generated code, do not edit.
var Dialect{{ print .Name }} = Migrations{
{{- range .Migrations }}
{

26
internal/mutex/mutex.go
View file

@ -1,3 +1,29 @@
/*
Package mutex provides concurrency control for index workers and database operations.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.
This program is free software: you can redistribute it and/or modify
it under Version 3 of the GNU Affero General Public License (the "AGPL"):
<https://docs.photoprism.app/license/agpl>
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
The AGPL is supplemented by our Trademark and Brand Guidelines,
which describe how our Brand Assets may be used:
<https://photoprism.app/trademark>
Feel free to send an email to hello@photoprism.app if you have questions,
want to support our work, or just want to say hello.
Additional information can be found in our Developer Guide:
<https://docs.photoprism.app/developer-guide/>
*/
package mutex
import (

2
internal/photoprism/photoprism.go
View file

@ -1,6 +1,6 @@
/*
Package photoprism contains PhotoPrism core functionality.
Package photoprism provides the core functionality of PhotoPrism®.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

5
internal/remote/remote.go
View file

@ -1,9 +1,6 @@
/*
Package remote implements remote service sync and uploads.
See also:
- RClone (https://rclone.org/), a popular Go tool for syncing data with remote services
Package remote provides detection of remote services for file sharing and synchronization.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

2
internal/remote/webdav/webdav.go
View file

@ -1,6 +1,6 @@
/*
Package webdav implements sharing with WebDAV servers.
Package webdav provides WebDAV file sharing and synchronization.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

2
internal/search/search.go
View file

@ -1,6 +1,6 @@
/*
Package search performs common index search queries.
Package search provides search queries to find photos, albums, labels, and subjects.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

27
internal/server/about.go Normal file
View file

@ -0,0 +1,27 @@
/*
Package server provides REST and web server routing, request handling and logging.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.
This program is free software: you can redistribute it and/or modify
it under Version 3 of the GNU Affero General Public License (the "AGPL"):
<https://docs.photoprism.app/license/agpl>
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
The AGPL is supplemented by our Trademark and Brand Guidelines,
which describe how our Brand Assets may be used:
<https://photoprism.app/trademark>
Feel free to send an email to hello@photoprism.app if you have questions,
want to support our work, or just want to say hello.
Additional information can be found in our Developer Guide:
<https://docs.photoprism.app/developer-guide/>
*/
package server

8
internal/server/doc.go
View file

@ -1,8 +0,0 @@
/*
Package server contains REST server routes and configuration.
Additional information concerning the API can be found in our Developer Guide:
https://github.com/photoprism/photoprism/wiki/REST-API
*/
package server

2
internal/workers/workers.go
View file

@ -1,6 +1,6 @@
/*
Package workers contains background workers for file sync & metadata optimization.
Package workers provides index, sync, and metadata optimization background workers.
Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved.

3
pkg/txt/countries.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package txt
// Generated code, do not edit.
var Countries = map[string]string{
"andorra": "ad",
"france": "fr",

4
pkg/txt/gen_countries.go
View file

@ -54,9 +54,11 @@ func main() {
})
}
var packageTemplate = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
var packageTemplate = template.Must(template.New("").Parse(`
package txt
// Generated code, do not edit.
var Countries = map[string]string{
{{- range .Countries }}
{{ printf "%q" .Name }}: {{ printf "%q" .Code }},

4
pkg/txt/gen_stopwords.go
View file

@ -48,9 +48,11 @@ func main() {
})
}
var packageTemplate = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
var packageTemplate = template.Must(template.New("").Parse(`
package txt
// Generated code, do not edit.
// StopWords contains a list of stopwords for full-text indexing.
var StopWords = map[string]bool{
{{- range .Words }}

3
pkg/txt/stopwords.go
View file

@ -1,6 +1,7 @@
// Code generated by go generate; DO NOT EDIT.
package txt
// Generated code, do not edit.
// StopWords contains a list of stopwords for full-text indexing.
var StopWords = map[string]bool{
"olymp": true,