From: nupplaPhil <admin@philipp.info>
Date: Sat, 25 Jan 2020 14:31:25 +0000 (+0100)
Subject: update PHPDoc
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=4c5856da2bc8851c90c62af01a432f71825718fd;p=friendica.git

update PHPDoc
---

diff --git a/src/Model/Notification.php b/src/Model/Notification.php
index ab029f73b6..11105d7983 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 56bc3ceba5..4972863caa 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 2e853a649a..925927d847 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';