BOINC / boinc

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';

html/inc/account.inc

Doc Comments +7 added lines

@@ -18,6 +18,10 @@ 
 
 // forms for account creation and login
 
+/**
+ * @param integer $teamid
+ * @param string $next_url
+ */
 function create_account_form($teamid, $next_url) {
     global $recaptcha_public_key;
     form_input_hidden('next_url', $next_url);
@@ -67,6 +71,9 @@ 
     }
 }
 
+/**
+ * @param string $next_url
+ */
 function login_form($next_url) {
     echo "
         <form name=\"f\" method=\"post\" action=\"".secure_url_base()."/login_action.php\">

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/bootstrap.inc

Doc Comments +33 added lines

@@ -30,6 +30,11 @@ 
 // $brand: the text or image to show at left of navbar
 // If text, put it in <a class="navbar-brand" ...
 //
+/**
+ * @param string $brand
+ * @param boolean $fixed
+ * @param boolean $inverse
+ */
 function navbar_start($brand, $fixed, $inverse) {
     global $fixed_navbar;
     $class = "navbar";
@@ -99,6 +104,9 @@ 
 
 // add a dropdown menu
 //
+/**
+ * @param string $name
+ */
 function navbar_menu($name, $items) {
     echo '
       <li class="dropdown">
@@ -218,6 +226,10 @@ 
 // output a panel.
 // $content_func is a function that generates the panel contents
 //
+/**
+ * @param string|null $title
+ * @param Closure $content_func
+ */
 function panel($title, $content_func, $class="panel-primary") {
     echo sprintf('<div class="panel %s">
         ', $class
@@ -244,6 +256,11 @@ 
 // are functions that generate the top, left, and right content
 // $left_width is the width of left column in 1/12 units.
 //
+/**
+ * @param boolean $top_func
+ * @param Closure $left_func
+ * @param Closure $right_func
+ */
 function grid($top_func, $left_func, $right_func, $left_width=6) {
     echo '
         <div class="container-fluid">
@@ -286,6 +303,9 @@ 
     );
 }
 
+/**
+ * @param string $name
+ */
 function form_input_hidden($name, $value) {
     echo '<input type="hidden" name="'.$name.'" value="'.$value.'">
     ';
@@ -301,6 +321,10 @@ 
 define('FORM_LEFT_OFFSET', 'col-sm-offset-5');
 define('FORM_RIGHT_CLASS', 'col-sm-7');
 
+/**
+ * @param string $label
+ * @param string $name
+ */
 function form_input_text($label, $name, $value='', $type='text', $attrs='') {
     echo sprintf('
         <div class="form-group">
@@ -343,6 +367,11 @@ 
 
 // $items is either a string of <option> elements, or an array
 //
+/**
+ * @param string $label
+ * @param string $name
+ * @param string $items
+ */
 function form_select($label, $name, $items) {
     echo sprintf('
         <div class="form-group">
@@ -428,6 +457,10 @@ 
     ';
 }
 
+/**
+ * @param string $label
+ * @param string $item
+ */
 function form_general($label, $item) {
     echo '
         <div class="form-group">

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;
 

drupal/sites/default/boinc/modules/boinctranslate/boinctranslate.module

Doc Comments +1 added lines

@@ -179,6 +179,7 @@
 /**
  * Implementation of hook_node_view(); add custom actions when a node
  * is viewed (forward compatible to Drupal 7)
+ * @param string $view_mode
  */
 function boinctranslate_node_view($node, $view_mode, $langcode) {
   switch($node->type) {

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

Doc Comments +4 added lines

@@ -512,6 +512,7 @@ 
 
 /**
  *
+ * @param string $type
  */
 function boinctranslate_export_po_generate($language = NULL, $strings = array(), $header = NULL, $type = NULL) {
 
@@ -886,6 +887,7 @@ 
 
 /**
  *
+ * @param stdClass $file
  */
 function _boinctranslate_locale_import_po($file, $langcode, $mode, $group = NULL) {
   // Try to allocate enough time to parse and import the data.
@@ -932,6 +934,7 @@ 
 
 /**
  *
+ * @param string $op
  */
 function _boinctranslate_locale_import_read_po($op, $file, $mode = NULL, $lang = NULL, $group = 'default') {
 
@@ -1283,6 +1286,7 @@ 
  *
  * Textgroups 'boinc' and 'project' use the location string to
  * uniquely identify rows in the locales_source database.
+ * @param string $textgroup
  */
 function _boinctranslate_locale_import_one_string_db(&$report, $langcode, $source, $translation, $textgroup, $location, $mode, $plid = NULL, $plural = NULL) {
 

html/user/submit_rpc_handler.php

Doc Comments +26 added lines

@@ -30,6 +30,9 @@ 
 ini_set('display_errors', true);
 ini_set('display_startup_errors', true);
 
+/**
+ * @param string $name
+ */
 function get_wu($name) {
     $name = BoincDb::escape_string($name);
     $wu = BoincWorkunit::lookup("name='$name'");
@@ -37,6 +40,9 @@ 
     return $wu;
 }
 
+/**
+ * @param string $name
+ */
 function get_submit_app($name) {
     $name = BoincDb::escape_string($name);
     $app = BoincApp::lookup("name='$name'");
@@ -76,6 +82,9 @@ 
     return $y;
 }
 
+/**
+ * @param SimpleXMLElement|null $template
+ */
 function est_elapsed_time($r, $template) {
     // crude estimate: batch FLOPs / project FLOPS
     //
@@ -122,6 +131,9 @@ 
     ";
 }
 
+/**
+ * @param SimpleXMLElement $template
+ */
 function validate_batch($jobs, $template) {
     $i = 0;
     $n = count($template->file_info);
@@ -191,6 +203,11 @@ 
 
 // submit a list of jobs with a single create_work command.
 //
+/**
+ * @param SimpleXMLElement|null $template
+ * @param double $priority
+ * @param integer $app_version_num
+ */
 function submit_jobs(
     $jobs, $template, $app, $batch_id, $priority, $app_version_num,
     $result_template_file,      // batch-level; can also specify per job
@@ -270,6 +287,9 @@ 
 // Check whether the template is already in our map.
 // If not, write it to a temp file.
 //
+/**
+ * @param stdClass $job
+ */
 function make_wu_template($job) {
     global $wu_templates;
     if (!array_key_exists($job->wu_template, $wu_templates)) {
@@ -286,6 +306,9 @@ 
 // A little different because these have to exist for life of job.
 // Store them in templates/tmp/, with content-based filenames
 //
+/**
+ * @param stdClass $job
+ */
 function make_result_template($job) {
     global $result_templates;
     if (!array_key_exists($job->result_template, $result_templates)) {
@@ -474,6 +497,9 @@ 
     ";
 }
 
+/**
+ * @param integer $get_cpu_time
+ */
 function print_batch_params($batch, $get_cpu_time) {
     $app = BoincApp::lookup_id($batch->app_id);
     if (!$app) $app->name = "none";

html/inc/util.inc

Doc Comments +54 added lines

@@ -123,6 +123,9 @@ 
     return secure_url_base();
 }
 
+/**
+ * @param string $name
+ */
 function send_cookie($name, $value, $permanent, $ops=false) {
     global $master_url;
 
@@ -205,6 +208,9 @@ 
 // To do so, define page_head() in the project include file.
 //
 if (!function_exists("page_head")){
+/**
+ * @param string $body_attrs
+ */
 function page_head(
     $title,
         // page title. Put in <title>, used as title for browser tab.
@@ -472,6 +478,9 @@ 
     ";
 }
 
+/**
+ * @param string $x
+ */
 function row2_init($x, $y, $lwidth='40%') {
     echo '<tr>
         <td class="text-right " width="'.$lwidth.'"  style="padding-right: 20px;">'.$x.'</td>
@@ -483,6 +492,9 @@ 
     echo "<tr><td>$x</td><td>$y</td></tr>\n";
 }
 
+/**
+ * @param string $string
+ */
 function rowify($string) {
     echo "<tr><td>$string</td></tr>";
 }
@@ -508,6 +520,9 @@ 
     echo "</tr>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row_heading($x, $class='bg-primary') {
     echo sprintf('<tr><th class="%s" colspan=99>%s</th></tr>
         ', $class, $x
@@ -568,6 +583,11 @@ 
 // If $ellipsis is true, then an ellipsis is added to any sentence which
 // is cut short.
 
+/**
+ * @param string $sentence
+ * @param string $delimiter
+ * @param integer $max_chars
+ */
 function sub_sentence($sentence, $delimiter, $max_chars, $ellipsis=false) {
     $words = explode($delimiter, $sentence);
     $total_chars = 0;
@@ -618,6 +638,9 @@ 
     ob_implicit_flush(0);
 }
 
+/**
+ * @param string $filename
+ */
 function close_output_buffer($filename) {
     $fh = fopen($filename, "w");
     $page = ob_get_contents();
@@ -686,6 +709,9 @@ 
 
 // returns null if the arg is optional and missing
 //
+/**
+ * @param string $name
+ */
 function post_int($name, $optional=false) {
     $x = post_num($name, $optional);
     if (is_null($x)) return null;
@@ -785,6 +811,9 @@ 
 
 // Generate a "select" element from an array of values
 //
+/**
+ * @param string $name
+ */
 function select_from_array($name, $array, $selection=null, $width=240) {
     $out = '<select style="color:#000;"class="form-control input-sm" style="width:'.$width.'px" name="'.$name.'">"';
 
@@ -854,6 +883,11 @@ 
 
 // for places with a bunch of buttons, like forum posts
 //
+/**
+ * @param string $url
+ * @param string $text
+ * @param string $desc
+ */
 function show_button_small($url, $text, $desc=null) {
     echo button_text($url, $text, $desc, "btn-primary btn-xs");
 }
@@ -873,6 +907,12 @@ 
 
 // used for showing icons
 //
+/**
+ * @param string $src
+ * @param string $title
+ * @param string $alt
+ * @param string $height
+ */
 function show_image($src, $title, $alt, $height=null) {
     $h = "";
     if ($height) {
@@ -988,6 +1028,9 @@ 
     }
 }
 
+/**
+ * @param integer $f
+ */
 function flops_to_credit($f) {
     return $f*(200/86400e9);
 }
@@ -1022,6 +1065,9 @@ 
     }
 }
 
+/**
+ * @param integer $height
+ */
 function badges_string($is_user, $item, $height) {
     if (DISABLE_BADGES) return null;
     if ($is_user) {
@@ -1038,6 +1084,9 @@ 
     return $x;
 }
 
+/**
+ * @param boolean $is_user
+ */
 function show_badges_row($is_user, $item) {
     if (BADGE_HEIGHT_LARGE == 0) return;
     $x = badges_string($is_user, $item, BADGE_HEIGHT_LARGE);
@@ -1082,6 +1131,11 @@ 
 // return HTML for a textarea with chars-remaining counter.
 // Call text_counter_script() before using this.
 //
+/**
+ * @param string $name
+ * @param integer $maxlen
+ * @param string $text
+ */
 function textarea_with_counter($name, $maxlen, $text) {
     $rem_name = $name."_remaining";
     return "<textarea name=\"$name\" class=\"form-control\" rows=3 id=\"$name\" onkeydown=\"text_counter(this.form.$name, this.form.$rem_name, $maxlen);\"