From 4c5856da2bc8851c90c62af01a432f71825718fd Mon Sep 17 00:00:00 2001 From: nupplaPhil Date: Sat, 25 Jan 2020 15:31:25 +0100 Subject: [PATCH] update PHPDoc --- src/Model/Notification.php | 5 ++++- src/Object/Notification/Introduction.php | 3 +++ src/Object/Notification/Notification.php | 3 +++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/Model/Notification.php b/src/Model/Notification.php index ab029f73b..11105d798 100644 --- a/src/Model/Notification.php +++ b/src/Model/Notification.php @@ -14,7 +14,10 @@ use Psr\Log\LoggerInterface; /** * Model for an entry in the notify table - * - Including additional calculated properties + * - Including additional, calculated properties + * + * Is used either for frontend interactions or for API-based interaction + * @see https://github.com/friendica/friendica/blob/develop/doc/API-Entities.md#notification * * @property string hash * @property integer type diff --git a/src/Object/Notification/Introduction.php b/src/Object/Notification/Introduction.php index 56bc3ceba..4972863ca 100644 --- a/src/Object/Notification/Introduction.php +++ b/src/Object/Notification/Introduction.php @@ -2,6 +2,9 @@ namespace Friendica\Object\Notification; +/** + * A view-only object for printing introduction notifications to the frontend + */ class Introduction implements \JsonSerializable { /** @var string */ diff --git a/src/Object/Notification/Notification.php b/src/Object/Notification/Notification.php index 2e853a649..925927d84 100644 --- a/src/Object/Notification/Notification.php +++ b/src/Object/Notification/Notification.php @@ -2,6 +2,9 @@ namespace Friendica\Object\Notification; +/** + * A view-only object for printing item notifications to the frontend + */ class Notification implements \JsonSerializable { const SYSTEM = 'system';