BOINC / boinc

html/inc/util_basic.inc

Doc Comments +9 added lines

@@ -92,6 +92,9 @@ 
 // Look for an element in a line of XML text
 // If it's a single-tag element, and it's present, just return the tag
 //
+/**
+ * @return string
+ */
 function parse_element($xml, $tag) {
     $element = null;
     $closetag = "</" . substr($tag,1);
@@ -107,6 +110,9 @@ 
     return trim($element);
 }
 
+/**
+ * @param string $tag
+ */
 function parse_next_element($xml, $tag, &$cursor) {
     $element = null;
     $closetag = "</" . substr($tag,1);
@@ -137,6 +143,9 @@ 
 
 // look for a particular element in the config file
 //
+/**
+ * @param string $tag
+ */
 function parse_config($config, $tag) {
     $element = parse_element($config, $tag);
     return $element;

html/inc/util.inc

Doc Comments +58 added lines

@@ -126,6 +126,9 @@ 
     return is_https()?secure_url_base():URL_BASE;
 }
 
+/**
+ * @param string $name
+ */
 function send_cookie($name, $value, $permanent, $ops=false) {
     global $master_url;
 
@@ -208,6 +211,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.
@@ -476,6 +482,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>
@@ -487,6 +496,9 @@ 
     echo "<tr><td>$x</td><td>$y</td></tr>\n";
 }
 
+/**
+ * @param string $string
+ */
 function rowify($string) {
     echo "<tr><td>$string</td></tr>";
 }
@@ -512,6 +524,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
@@ -574,6 +589,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;
@@ -624,6 +644,9 @@ 
     ob_implicit_flush(0);
 }
 
+/**
+ * @param string $filename
+ */
 function close_output_buffer($filename) {
     $fh = fopen($filename, "w");
     $page = ob_get_contents();
@@ -692,6 +715,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;
@@ -791,6 +817,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,18 +883,33 @@ 
     );
 }
 
+/**
+ * @param string $text
+ * @param string $desc
+ */
 function show_button($url, $text, $desc=null, $class="btn-success btn-sm") {
     echo button_text($url, $text, $desc=null, $class);
 }
 
 // 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");
 }
 
 // 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) {
@@ -986,6 +1030,9 @@ 
     }
 }
 
+/**
+ * @param integer $f
+ */
 function flops_to_credit($f) {
     return $f*(200/86400e9);
 }
@@ -1020,6 +1067,9 @@ 
     }
 }
 
+/**
+ * @param integer $height
+ */
 function badges_string($is_user, $item, $height) {
     if (DISABLE_BADGES) return null;
     if ($is_user) {
@@ -1036,6 +1086,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);
@@ -1080,6 +1133,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);\"

html/inc/account.inc

Doc Comments +10 added lines

@@ -31,6 +31,9 @@ 
 
 // return HTML string for a checkbox for toggling password visibility
 //
+/**
+ * @param string $name
+ */
 function passwd_visible_checkbox($name) {
     return sprintf('
 <script>
@@ -48,6 +51,10 @@ 
     );
 }
 
+/**
+ * @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);
@@ -111,6 +118,9 @@ 
     }
 }
 
+/**
+ * @param string $next_url
+ */
 function login_form($next_url) {
     form_start(secure_url_base()."/login_action.php", "post");
     form_input_hidden("next_url", $next_url);

html/user/submit_rpc_handler.php

Doc Comments +28 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
     //
@@ -131,6 +140,9 @@ 
 // The arg is the batch-level template, if any.
 // Jobs may have their own templates.
 //
+/**
+ * @param SimpleXMLElement $template
+ */
 function validate_batch($jobs, $template) {
     $i = 0;
     $n = count($template->file_info);
@@ -200,6 +212,13 @@ 
 
 // submit a list of jobs with a single create_work command.
 //
+/**
+ * @param stdClass $job_params
+ * @param double $priority
+ * @param integer $app_version_num
+ * @param string $input_template_filename
+ * @param string $output_template_filename
+ */
 function submit_jobs(
     $jobs, $job_params, $app, $batch_id, $priority, $app_version_num,
     $input_template_filename,        // batch-level; can also specify per job
@@ -294,6 +313,9 @@ 
 // Check whether the template is already in our map.
 // If not, write it to a temp file.
 //
+/**
+ * @param stdClass $job
+ */
 function make_input_template($job) {
     global $input_templates;
     if (!array_key_exists($job->input_template_xml, $input_templates)) {
@@ -310,6 +332,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_output_template($job) {
     global $output_templates;
     if (!array_key_exists($job->output_template_xml, $output_templates)) {
@@ -508,6 +533,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/random_compat/random.inc

Doc Comments +1 added lines, -1 removed lines

@@ -202,7 +202,7 @@
          * We don't have any more options, so let's throw an exception right now
          * and hope the developer won't let it fail silently.
          *
-         * @param mixed $length
+         * @param integer $length
          * @psalm-suppress MissingReturnType
          * @throws Exception
          * @return string

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

Doc Comments +1 added lines, -1 removed lines

@@ -540,7 +540,7 @@
  * @param $file
  *   A file object.
  * @return
- *   The URL of the icon image file, or FALSE if no icon could be found.
+ string|false   The URL of the icon image file, or FALSE if no icon could be found.
  */
 function filefield_icon_url($file) {
   module_load_include('inc', 'filefield', 'filefield.theme');

drupal/sites/default/boinc/modules/contrib/filefield/filefield_widget.inc

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
  * @param $account
  *   The user account object to calculate the file path for.
  * @return
- *   The files directory path, with any tokens replaced.
+ string   The files directory path, with any tokens replaced.
  */
 function filefield_widget_file_path($field, $account = NULL) {
   $account = isset($account) ? $account : $GLOBALS['user'];

html/inc/user_util.inc

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
 // return true if the passwd hash (old format)
 // matches the user's passwd hash (possibly new format)
 //
+/**
+ * @param string $passwd_hash
+ */
 function check_passwd_hash($user, $passwd_hash) {
     if (password_verify($passwd_hash, $user->passwd_hash)) {
         // on valid login, rehash password to upgrade hash overtime

html/inc/user.inc

Doc Comments +3 added lines

@@ -113,6 +113,9 @@
     return ($a->expavg_credit < $b->expavg_credit) ? 1 : -1;
 }
 
+/**
+ * @param boolean $personal
+ */
 function show_other_projects($user, $personal) {
     if (!isset($user->projects)) return;
     if (count($user->projects) < 2) return;