From 6a9b649cd76b276afe2baf27be8b46504fe1bb32 Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Fri, 13 Jul 2018 12:32:27 +0100 Subject: [PATCH] Add classes description on docblock --- actions/apactorfollowers.php | 2 ++ actions/apactorfollowing.php | 2 ++ actions/apactorinbox.php | 2 ++ actions/apactorlikedcollection.php | 2 ++ actions/apactorprofile.php | 2 ++ actions/apsharedinbox.php | 2 ++ classes/Activitypub_attachment.php | 2 ++ classes/Activitypub_error.php | 2 ++ classes/Activitypub_notice.php | 2 ++ classes/Activitypub_profile.php | 2 ++ classes/Activitypub_tag.php | 2 ++ utils/explorer.php | 4 ++++ utils/postman.php | 5 +++++ 13 files changed, 31 insertions(+) diff --git a/actions/apactorfollowers.php b/actions/apactorfollowers.php index 8e32a10..9205bd7 100644 --- a/actions/apactorfollowers.php +++ b/actions/apactorfollowers.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Actor's Followers Collection + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/actions/apactorfollowing.php b/actions/apactorfollowing.php index f5bc75f..4bb695e 100644 --- a/actions/apactorfollowing.php +++ b/actions/apactorfollowing.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Actor's Following Collection + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/actions/apactorinbox.php b/actions/apactorinbox.php index b662368..47aa091 100644 --- a/actions/apactorinbox.php +++ b/actions/apactorinbox.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Actor's Inbox + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/actions/apactorlikedcollection.php b/actions/apactorlikedcollection.php index c6b128f..c9c05db 100644 --- a/actions/apactorlikedcollection.php +++ b/actions/apactorlikedcollection.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Actor's Liked Collection + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/actions/apactorprofile.php b/actions/apactorprofile.php index f026728..b32d595 100644 --- a/actions/apactorprofile.php +++ b/actions/apactorprofile.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Actor's profile (Local users only) + * * @category Plugin * @package GNUsocial * @author Daniel Supernault diff --git a/actions/apsharedinbox.php b/actions/apsharedinbox.php index 2f8321e..007d392 100644 --- a/actions/apsharedinbox.php +++ b/actions/apsharedinbox.php @@ -31,6 +31,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * Shared Inbox Handler + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/classes/Activitypub_attachment.php b/classes/Activitypub_attachment.php index 691277b..e20a487 100644 --- a/classes/Activitypub_attachment.php +++ b/classes/Activitypub_attachment.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub Attachment representation + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/classes/Activitypub_error.php b/classes/Activitypub_error.php index b14299b..e0637cd 100644 --- a/classes/Activitypub_error.php +++ b/classes/Activitypub_error.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub error representation + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/classes/Activitypub_notice.php b/classes/Activitypub_notice.php index 8868dd9..88f8f5c 100644 --- a/classes/Activitypub_notice.php +++ b/classes/Activitypub_notice.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub notice representation + * * @category Plugin * @package GNUsocial * @author Daniel Supernault diff --git a/classes/Activitypub_profile.php b/classes/Activitypub_profile.php index 3c5f93e..3d8bc06 100644 --- a/classes/Activitypub_profile.php +++ b/classes/Activitypub_profile.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub Profile + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/classes/Activitypub_tag.php b/classes/Activitypub_tag.php index 9f27a96..1e94862 100644 --- a/classes/Activitypub_tag.php +++ b/classes/Activitypub_tag.php @@ -30,6 +30,8 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub representation of a Tag + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/utils/explorer.php b/utils/explorer.php index cbf9d38..de7d65f 100644 --- a/utils/explorer.php +++ b/utils/explorer.php @@ -30,6 +30,10 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub's own Explorer + * + * Allows to discovery new (or the same) ActivityPub profiles + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro diff --git a/utils/postman.php b/utils/postman.php index 4fa69fb..ab995a2 100644 --- a/utils/postman.php +++ b/utils/postman.php @@ -30,6 +30,11 @@ if (!defined ('GNUSOCIAL')) { } /** + * ActivityPub's own Postman + * + * Standard workflow expects that we send an Explorer to find out destinataries' + * inbox address. Then we send our postman to deliver whatever we want to send them. + * * @category Plugin * @package GNUsocial * @author Diogo Cordeiro