]> git.mxchange.org Git - friendica.git/commitdiff
update PHPDoc
authornupplaPhil <admin@philipp.info>
Sat, 25 Jan 2020 14:31:25 +0000 (15:31 +0100)
committernupplaPhil <admin@philipp.info>
Sat, 25 Jan 2020 18:58:27 +0000 (19:58 +0100)
src/Model/Notification.php
src/Object/Notification/Introduction.php
src/Object/Notification/Notification.php

index ab029f73b6b4416fd0182e9979bac47c3627e314..11105d798392f65723c81bf65ee1b6c0a6a0ccea 100644 (file)
@@ -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
index 56bc3ceba5a1fc3031eb24d259326c52923dc14b..4972863caa1bc5748463f9112f0f8cbdcb16cfd9 100644 (file)
@@ -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 */
index 2e853a649a59712e43d14c55dfd3606aa1201cb5..925927d84722d8bae68f4fa11160ea66cc648311 100644 (file)
@@ -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';