BOINC / boinc

drupal/sites/default/boinc/modules/contrib/flag/flag.inc

Doc Comments +6 added lines, -5 removed lines

@@ -430,7 +430,7 @@ 
    *   Optional. The user object. If none given, the current user will be used.
    *
    * @return
-   *   Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise.
+   boolean   Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise.
    */
   function user_access($action = 'flag', $account = NULL) {
     if (!isset($account)) {
@@ -620,7 +620,7 @@ 
    * @param $skip_permission_check
    *   Flag the item even if the $account user don't have permission to do so.
    * @return
-   *   FALSE if some error occured (e.g., user has no permission, flag isn't
+   boolean   FALSE if some error occured (e.g., user has no permission, flag isn't
    *   applicable to the item, etc.), TRUE otherwise.
    */
   function flag($action, $content_id, $account = NULL, $skip_permission_check = FALSE) {
@@ -702,7 +702,7 @@ 
    *   current user will be used.
    *
    * @return
-   *   TRUE if the content is flagged, FALSE otherwise.
+   boolean   TRUE if the content is flagged, FALSE otherwise.
    */
   function is_flagged($content_id, $uid = NULL, $sid = NULL) {
     return (bool) $this->get_flagging_record($content_id, $uid, $sid);
@@ -875,7 +875,7 @@ 
    * E.g., do `print $flag->get_label('title')` instead of `print
    * $flag->title`.
    *
-   * @param $label
+   * @param string $label
    *   The label to get, e.g. 'title', 'flag_short', 'unflag_short', etc.
    * @param $content_id
    *   The ID in whose context to interpret tokens. If not given, only global
@@ -1147,7 +1147,7 @@ 
    * call flag_get_flag($this->name) again.
    *
    * @return
-   *   TRUE if the flag was reverted successfully; FALSE if there was an error;
+   boolean|null   TRUE if the flag was reverted successfully; FALSE if there was an error;
    *   NULL if this flag overrides no default flag.
    */
   function revert() {
@@ -1787,6 +1787,7 @@ 
 
   /**
    * Returns the actual storage object compatible with the flag.
+   * @param flag_flag $flag
    */
   static function factory($flag) {
     if ($flag->global) {

drupal/sites/default/boinc/modules/contrib/flag/flag.module

Doc Comments +3 added lines, -3 removed lines

@@ -1204,7 +1204,7 @@ 
 /**
  * Get flag counts for all flags on a node.
  *
- * @param $content_type
+ * @param null|string $content_type
  *   The content type (usually 'node').
  * @param $content_id
  *   The content ID (usually the node ID).
@@ -1400,7 +1400,7 @@ 
  *   The subtype (node type) being checked.
  *
  * @return
- *   TRUE if the flag is enabled for this type and subtype.
+ boolean   TRUE if the flag is enabled for this type and subtype.
  */
 function _flag_content_enabled($flag, $content_type, $content_subtype = NULL) {
   $return = $flag->content_type == $content_type && (!isset($content_subtype) || in_array($content_subtype, $flag->types));
@@ -1481,7 +1481,7 @@ 
 /**
  * Find what a user has flagged, either a single node or on the entire site.
  *
- * @param $content_type
+ * @param null|string $content_type
  *   The type of content that will be retrieved. Usually 'node'.
  * @param $content_id
  *   Optional. The content ID to check for flagging. If none given, all

drupal/sites/default/boinc/modules/contrib/flag/flag_actions.module

Doc Comments +1 added lines

@@ -506,6 +506,7 @@
  * Execute an action form callback to retrieve form additions.
  *
  * This function prevents the form callback from modifying local variables.
+ * @param string $callback
  */
 function flag_actions_form_additions($callback, $edit) {
   return $callback($edit);

drupal/sites/default/boinc/modules/contrib/flag/includes/flag.actions.inc

Doc Comments +1 added lines, -1 removed lines

@@ -178,7 +178,7 @@
  *
  * @param $context
  *   The current action context.
- * @param $content_type
+ * @param string $content_type
  *   The content type applicable to this action, such as "node" or "comment".
  */
 function flag_action_form($context, $content_type) {

drupal/sites/default/boinc/modules/contrib/flag/includes/flag.views.inc

Doc Comments +1 added lines

@@ -258,6 +258,7 @@
  *
  * This function is used to select the desired flag when setting up flag
  * relationships and fields.
+ * @param string $form_type
  */
 function flag_views_flag_config_form($form_type, $content_type, $current_flag) {
   $flags = flag_get_flags($content_type);

drupal/sites/default/boinc/modules/contrib/flag/includes/flag_plugin_argument_validate_flaggability.inc

Doc Comments +2 added lines

@@ -116,6 +116,8 @@
    * Returns an option's value.
    *
    * Purpose: insulate us from the difference between Views 3 and Views 2.
+   * @param string $option
+   * @param string $default
    */
   function _get_option($option, $default) {
     if (_flag_is_views3()) {

drupal/sites/default/boinc/modules/contrib/views/includes/handlers.inc

Doc Comments +5 added lines, -2 removed lines

@@ -30,6 +30,7 @@ 
  *
  * This will also attempt to include all parents, though we're maxing the
  * parent chain to 10 to prevent infinite loops.
+ * @param string $type
  */
 function views_include_handler($definition, $type, $count = 0) {
   // Do not proceed if the class already exists.
@@ -912,7 +913,7 @@ 
 /**
  * Helper function to create cross-database SQL date formatting.
  *
- * @param $format
+ * @param string $format
  *   A format string for the result, like 'Y-m-d H:i:s'.
  * @param $field
  *   The real table and field name, like 'tablename.fieldname'.
@@ -978,7 +979,7 @@ 
 /**
  * Helper function to create cross-database SQL date extraction.
  *
- * @param $extract_type
+ * @param string $extract_type
  *   The type of value to extract from the date, like 'MONTH'.
  * @param $field
  *   The real table and field name, like 'tablename.fieldname'.
@@ -1246,6 +1247,8 @@ 
 class views_join {
   /**
    * Construct the views_join object.
+   * @param string $table
+   * @param string $field
    */
   function construct($table = NULL, $left_table = NULL, $left_field = NULL, $field = NULL, $extra = array(), $type = 'LEFT') {
     $this->extra_type = 'AND';

drupal/sites/default/boinc/modules/boincwork/includes/boincwork.helpers.inc

Doc Comments +6 added lines

@@ -977,6 +977,7 @@ 
 
 /**
  * Format a number to be displayed using a maximum number of digits
+ * @param double $number
  */ 
 function boincwork_format_stats($number, $max_digits = 4) {
   $suffix = array(
@@ -1187,6 +1188,9 @@ 
   //  xml_to_array(): Convert an XML DOM object to array format
   //------------------------------------------------------------------------------------------------
   
+  /**
+   * @param DOMDocument $xml
+   */
   function xml_to_array($xml) {
       $node = $xml->firstChild; //$xml->first_child();
       $result = '';
@@ -1269,6 +1273,7 @@ 
 
 /**
   * Determine output for host list views when no hosts are found.
+  * @param string $context
   */
 function boincwork_views_host_list_empty_text($context = NULL) {
   
@@ -1818,6 +1823,7 @@ 
 
 /**
  * Function to delete a column from an array.
+ * @param integer $offset
  */
 function delete_col(&$array, $offset) {
   return array_walk($array, function (&$v) use ($offset) {

html/inc/pm.inc

Doc Comments +13 added lines

@@ -48,6 +48,10 @@ 
     return $x;
 }
 
+/**
+ * @param null|integer $teamid
+ * @param string $error
+ */
 function pm_team_form($user, $teamid, $error=null) {
     global $bbcode_html, $bbcode_js;
     $team = BoincTeam::lookup_id($teamid);
@@ -99,6 +103,9 @@ 
     page_tail();
 }
 
+/**
+ * @param string $error
+ */
 function pm_form($replyto, $userid, $error = null) {
     global $bbcode_html, $bbcode_js;
     global $g_logged_in_user;
@@ -217,6 +224,9 @@ 
     return "<a href=pm.php>".tra("Private message%1 from %2, subject:" , "</a>", $from_user->name )." $pm->subject";
 }
 
+/**
+ * @param boolean $send_email
+ */
 function pm_send_msg($from_user, $to_user, $subject, $content, $send_email) {
     $sql_subject = BoincDb::escape_string(sanitize_tags($subject));
     $sql_content = BoincDb::escape_string($content);
@@ -245,6 +255,9 @@ 
     BoincNotify::insert("(userid, create_time, type, opaque) values ($to_user->id, ".time().", ".NOTIFY_PM.", $mid)");
 }
 
+/**
+ * @param integer $duration
+ */
 function pm_count($userid, $duration) {
     $time = time() - $duration;