Add some documentation to Component.php

Chris Pollett [2022-09-17 04:Sep:th]
Add some documentation to Component.php
Filename
src/controllers/components/Component.php
src/views/elements/SocialcontrolsElement.php
diff --git a/src/controllers/components/Component.php b/src/controllers/components/Component.php
index 57db3862d..3ea6c4014 100644
--- a/src/controllers/components/Component.php
+++ b/src/controllers/components/Component.php
@@ -167,9 +167,13 @@ class Component
         }
     }
     /**
+     * Used to compute statistics for badges related for the manage crawls,
+     * mix crawls, and manage machine buttons shown typically to admin accounts
      *
-     * @param int $user_id
-     * @param array &$data
+     * @param int $user_id of user - used to determin the mix crawl list
+     * @param array &$data associative array of data to send to the view.
+     *  This method adds three new field NUM_MIXES, CRAWL_MANAGER,
+     *  "NUM_MACHINES, CRAWLS_RUNNING, and NUM_CLOSED_CRAWLS
      */
     public function initCrawlBadges($user_id, &$data)
     {
@@ -191,9 +195,14 @@ class Component
         }
     }
     /**
-     *
-     * @param int $user_id
-     * @param array &$data
+     * Used to compute the impression statistics for badges on the
+     * social controls button for $user_id.  These badges
+     * display the number of unread messages, the number of unread group post
+     * and the number of groups the user belongs to
+     * @param int $user_id id of user to compute statistics for
+     * @param array &$data associative array of data to send to the view.
+     *  This method adds three new field NUM_GROUPS, UNREAD_POSTS, and
+     *  UNREAD_MESSAGES
      */
     public function initSocialBadges($user_id, &$data)
     {
diff --git a/src/views/elements/SocialcontrolsElement.php b/src/views/elements/SocialcontrolsElement.php
index 976304047..cf7470aa5 100644
--- a/src/views/elements/SocialcontrolsElement.php
+++ b/src/views/elements/SocialcontrolsElement.php
@@ -38,7 +38,7 @@ use seekquarry\yioop\library as L;
  * Used to the control buttons on manage account, manage groups, group feed, etc
  * pages
  *
- * @authorChris Pollett
+ * @author Chris Pollett
  */
 class SocialcontrolsElement extends Element
 {
ViewGit