From 877a5be8e9a1d5dc3a5ed5bc5a928ad79652b2ee Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 25 Apr 2022 10:45:09 +0200 Subject: [PATCH] Backend: Update Go package descriptions to improve generated docs see https://pkg.go.dev/github.com/photoprism/photoprism --- internal/hub/places/places.go | 2 +- internal/maps/maps.go | 2 +- internal/nsfw/nsfw.go | 2 +- internal/service/service.go | 26 ++++++++++++++++++++++++++ 4 files changed, 29 insertions(+), 3 deletions(-) diff --git a/internal/hub/places/places.go b/internal/hub/places/places.go index df87977f6..16cf7b629 100644 --- a/internal/hub/places/places.go +++ b/internal/hub/places/places.go @@ -1,6 +1,6 @@ /* -Package places encapsulates the PhotoPrism Places geolocation API. +Package places provides global location information to enrich metadata with location details. Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved. diff --git a/internal/maps/maps.go b/internal/maps/maps.go index ab998e6ca..d3144ba83 100644 --- a/internal/maps/maps.go +++ b/internal/maps/maps.go @@ -1,6 +1,6 @@ /* -Package maps encapsulates external geolocation APIs. +Package maps provides a location lookup abstraction including a normalized list of countries. Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved. diff --git a/internal/nsfw/nsfw.go b/internal/nsfw/nsfw.go index 1ceaaaba3..d612bc008 100644 --- a/internal/nsfw/nsfw.go +++ b/internal/nsfw/nsfw.go @@ -1,6 +1,6 @@ /* -Package nsfw uses TensorFlow to detect images that may not be safe for work. +Package nsfw provides detection of images that are "not safe for work" based on various categories. Copyright (c) 2018 - 2022 PhotoPrism UG. All rights reserved. diff --git a/internal/service/service.go b/internal/service/service.go index 3231be357..dd2b72ef6 100644 --- a/internal/service/service.go +++ b/internal/service/service.go @@ -1,3 +1,29 @@ +/* + +Package service provides a registry for common services. + +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 service import (