diff --git a/internal/acl/acl.go b/internal/acl/acl.go index 250c9d89d..2bc4f279b 100644 --- a/internal/acl/acl.go +++ b/internal/acl/acl.go @@ -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. diff --git a/internal/api/api.go b/internal/api/api.go index bf49fdb56..817c90b89 100644 --- a/internal/api/api.go +++ b/internal/api/api.go @@ -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. diff --git a/internal/api/doc.go b/internal/api/doc.go deleted file mode 100644 index 0cb336c46..000000000 --- a/internal/api/doc.go +++ /dev/null @@ -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 diff --git a/internal/auto/auto.go b/internal/auto/auto.go index 66c78a9b2..4a518d92c 100644 --- a/internal/auto/auto.go +++ b/internal/auto/auto.go @@ -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. diff --git a/internal/classify/gen.go b/internal/classify/gen.go index df357249d..304b90960 100644 --- a/internal/classify/gen.go +++ b/internal/classify/gen.go @@ -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 }}: { diff --git a/internal/classify/rules.go b/internal/classify/rules.go index 54ec3ae1a..055fd006d 100644 --- a/internal/classify/rules.go +++ b/internal/classify/rules.go @@ -1,6 +1,7 @@ -// Code generated by go generate; DO NOT EDIT. package classify +// Generated code, do not edit. + var Rules = LabelRules{ "abacus": { Label: "", diff --git a/internal/config/about.go b/internal/config/about.go index f9ca211d4..cf5920699 100644 --- a/internal/config/about.go +++ b/internal/config/about.go @@ -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. diff --git a/internal/hub/hub.go b/internal/hub/hub.go index ae2f6fa73..01f73e185 100644 --- a/internal/hub/hub.go +++ b/internal/hub/hub.go @@ -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. diff --git a/internal/i18n/i18n.go b/internal/i18n/i18n.go index 41ed39322..8b217fd3a 100644 --- a/internal/i18n/i18n.go +++ b/internal/i18n/i18n.go @@ -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. diff --git a/internal/maps/countries.go b/internal/maps/countries.go index c569c76e9..ee7efabd6 100644 --- a/internal/maps/countries.go +++ b/internal/maps/countries.go @@ -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", diff --git a/internal/maps/gen.go b/internal/maps/gen.go index fccfc8d4b..af72a4465 100644 --- a/internal/maps/gen.go +++ b/internal/maps/gen.go @@ -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 }}, diff --git a/internal/meta/meta.go b/internal/meta/meta.go index 0f0675e25..f3b7b8463 100644 --- a/internal/meta/meta.go +++ b/internal/meta/meta.go @@ -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. diff --git a/internal/migrate/dialect_mysql.go b/internal/migrate/dialect_mysql.go index 0ccd0db15..adb4f8b92 100644 --- a/internal/migrate/dialect_mysql.go +++ b/internal/migrate/dialect_mysql.go @@ -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", diff --git a/internal/migrate/dialect_sqlite3.go b/internal/migrate/dialect_sqlite3.go index 1550ef5d2..2424d33a0 100644 --- a/internal/migrate/dialect_sqlite3.go +++ b/internal/migrate/dialect_sqlite3.go @@ -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", diff --git a/internal/migrate/generate.go b/internal/migrate/generate.go index f2d1fdb55..8073da123 100644 --- a/internal/migrate/generate.go +++ b/internal/migrate/generate.go @@ -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 }} { diff --git a/internal/mutex/mutex.go b/internal/mutex/mutex.go index c8303af94..e23228075 100644 --- a/internal/mutex/mutex.go +++ b/internal/mutex/mutex.go @@ -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"): + + + 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: + + +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: + + +*/ package mutex import ( diff --git a/internal/photoprism/photoprism.go b/internal/photoprism/photoprism.go index 17a1a7126..469dae74c 100644 --- a/internal/photoprism/photoprism.go +++ b/internal/photoprism/photoprism.go @@ -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. diff --git a/internal/remote/remote.go b/internal/remote/remote.go index 71e0cff46..dd8c23ae9 100644 --- a/internal/remote/remote.go +++ b/internal/remote/remote.go @@ -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. diff --git a/internal/remote/webdav/webdav.go b/internal/remote/webdav/webdav.go index 1250c0e19..4423d1aea 100644 --- a/internal/remote/webdav/webdav.go +++ b/internal/remote/webdav/webdav.go @@ -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. diff --git a/internal/search/search.go b/internal/search/search.go index a7c0b36f4..3310c52e9 100644 --- a/internal/search/search.go +++ b/internal/search/search.go @@ -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. diff --git a/internal/server/about.go b/internal/server/about.go new file mode 100644 index 000000000..d81e51519 --- /dev/null +++ b/internal/server/about.go @@ -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"): + + + 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: + + +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: + + +*/ +package server diff --git a/internal/server/doc.go b/internal/server/doc.go deleted file mode 100644 index ac6131865..000000000 --- a/internal/server/doc.go +++ /dev/null @@ -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 diff --git a/internal/workers/workers.go b/internal/workers/workers.go index 641536be9..9c1971c78 100644 --- a/internal/workers/workers.go +++ b/internal/workers/workers.go @@ -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. diff --git a/pkg/txt/countries.go b/pkg/txt/countries.go index 289de5792..6bb3a8fe1 100644 --- a/pkg/txt/countries.go +++ b/pkg/txt/countries.go @@ -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", diff --git a/pkg/txt/gen_countries.go b/pkg/txt/gen_countries.go index 37e3b36e0..5674234fe 100644 --- a/pkg/txt/gen_countries.go +++ b/pkg/txt/gen_countries.go @@ -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 }}, diff --git a/pkg/txt/gen_stopwords.go b/pkg/txt/gen_stopwords.go index dfcfbd082..75bdf2284 100644 --- a/pkg/txt/gen_stopwords.go +++ b/pkg/txt/gen_stopwords.go @@ -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 }} diff --git a/pkg/txt/stopwords.go b/pkg/txt/stopwords.go index 4fd50e190..cfc2ceb1a 100644 --- a/pkg/txt/stopwords.go +++ b/pkg/txt/stopwords.go @@ -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,