BOINC / boinc

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

Doc Comments +15 added lines

@@ -220,6 +220,9 @@ 
 // (to accommodate long [pre] lines)
 // and the left column (author info) has fixed size
 //
+/**
+ * @param string[] $headings
+ */
 function start_forum_table($headings) {
     $a = array();
     foreach ($headings as $h) {
@@ -500,6 +503,9 @@ 
 // Display an individual post.
 // Generates a table row with two cells: author and message
 //
+/**
+ * @param integer $controls
+ */
 function show_post(
     $post, $thread, $forum, $logged_in_user, $start=0,
     $latest_viewed=0, $controls=FORUM_CONTROLS, $filter=true
@@ -875,6 +881,9 @@ 
 // These take care of counts and timestamps.
 // Don't do these things directly - use these functions
 //
+/**
+ * @param integer $parent_id
+ */
 function create_post($content, $parent_id, $user, $forum, $thread, $signature) {
     if (POST_MAX_LINKS
         && link_count($content) > POST_MAX_LINKS
@@ -1119,6 +1128,9 @@ 
 // $sort_style - string (checked by switch statement)
 // $show_hidden - bool (not directly passed to SQL)
 //
+/**
+ * @param boolean $show_hidden
+ */
 function get_thread_posts($threadid, $sort_style, $show_hidden) {
     $sql = "thread=$threadid";
     if (!$show_hidden) {
@@ -1144,6 +1156,9 @@ 
 // Show links for post moderation actions;
 // logged in user has moderation rights.
 //
+/**
+ * @param string $config
+ */
 function show_post_moderation_links(
     $config, $logged_in_user, $post, $forum, $tokens
 ){

drupal/sites/default/boinc/themes/boinc/template.php

Doc Comments +1 added lines

@@ -882,6 +882,7 @@
 /**
  * Private function, based on ignore_user ignore_user_link()
  * function. Modified for boinc functionality.
+ * @param string $type
  */
 function _boinc_ignore_user_link($type, $object = NULL, $teaser = FALSE) {
   global $user;

html/inc/boinc_db.inc

Doc Comments +118 added lines

@@ -40,6 +40,10 @@ 
     // 2: only use replica_db_user, only try replica_db_host
     // can be set projectwide using <replica_fallback_mode>
     //
+
+    /**
+     * @param boolean $readonly
+     */
     static function get_aux($readonly, $fallback_mode = 0) {
         $config = get_config();
         $user = parse_config($config, '<db_user>');
@@ -204,6 +208,10 @@ 
         $db = BoincDb::get();
         return $db->count('user', $clause);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('user', $field);
@@ -216,6 +224,10 @@ 
         $db = BoincDb::get();
         return $db->enum('user', 'BoincUser', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -233,10 +245,19 @@ 
         $db->delete_aux('profile', "userid=$this->id");
         return $db->delete($this, 'user');
     }
+
+    /**
+     * @param string $field
+     */
     static function sum($field) {
         $db = BoincDb::get();
         return $db->sum('user', $field);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('user', $field, $clause, $pct);
@@ -245,6 +266,10 @@ 
 
 class BoincTeam {
     static $cache;
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('team', $clause);
@@ -282,14 +307,27 @@ 
         $db = BoincDb::get();
         return $db->delete($this, 'team');
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('team', $field, $clause, $pct);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('team', $field);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -326,6 +364,12 @@ 
         $db = BoincDb::get();
         return $db->enum('host', 'BoincHost', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -358,6 +402,11 @@ 
         $db = BoincDb::get();
         return $db->enum('result', 'BoincResult', $where_clause);
     }
+
+	/**
+	 * @param string $fields
+	 * @param string $where_clause
+	 */
 	static function enum_fields($fields, $where_clause, $order_clause) {
         $db = BoincDb::get();
 		return $db->enum_fields('result', 'BoincResult', $fields, $where_clause, $order_clause);
@@ -412,6 +461,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('workunit', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function count($clause) {
         $db = BoincDb::get();
         return $db->count('workunit', $clause);
@@ -427,6 +480,10 @@ 
         $db = BoincDb::get();
         return $db->lookup('app', 'BoincApp', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('app', 'BoincApp', $where_clause);
@@ -441,6 +498,11 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'app', $clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause=null) {
         $db = BoincDb::get();
         return $db->sum('app', $field, $clause);
@@ -473,6 +535,10 @@ 
 }
 
 class BoincProfile {
+
+    /**
+     * @param string $fields
+     */
     static function lookup_fields($fields, $clause) {
         $db = BoincDb::get();
         return $db->lookup_fields('profile', 'BoincProfile', $fields, $clause);
@@ -489,18 +555,37 @@ 
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause.' where userid='.$this->userid);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         return $db->insert('profile', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum($where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum('profile', 'BoincProfile', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields('profile', 'BoincProfile', $fields, $where_clause, $order_clause);
@@ -568,6 +653,10 @@ 
 }
 
 class BoincPlatform {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('platform', 'BoincPlatform', $where_clause);
@@ -648,6 +737,10 @@ 
 }
 
 class BoincBadge {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('badge', 'BoincBadge', $where_clause);
@@ -743,6 +836,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_user', 'BoincCreditUser', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_user', $field, $clause);
@@ -755,6 +853,11 @@ 
         $db = BoincDb::get();
         $db->delete_aux('credit_user', "userid=$user->id");
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('user', 'credit_user', 'id', 'userid', 'BoincCreditUser', '*', $where_clause, $order_clause, $limit);
@@ -770,6 +873,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_team', 'BoincCreditTeam', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_team', $field, $clause);
@@ -778,6 +886,11 @@ 
         $db = BoincDb::get();
         return $db->update_aux('credit_team', $clause);
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('team', 'credit_team', 'id', 'teamid', 'BoincCreditTeam', '*', $where_clause, $order_clause, $limit);
@@ -788,6 +901,11 @@ 
 // 
 // apply this to any user-supplied strings used in queries
 // 
+/**
+ * @param string $x
+ *
+ * @return string
+ */
 function boinc_real_escape_string($x) {
     if (version_compare(phpversion(),"4.3.0")>=0) {
         return BoincDb::escape_string($x);

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

Doc Comments +42 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">
@@ -277,6 +294,9 @@ 
     ';
 }
 
+/**
+ * @param string $action
+ */
 function form_start($action, $method='get') {
     echo sprintf(
         '<div class="container">
@@ -286,6 +306,9 @@ 
     );
 }
 
+/**
+ * @param string $name
+ */
 function form_input_hidden($name, $value) {
     echo '<input type="hidden" name="'.$name.'" value="'.$value.'">
     ';
@@ -301,6 +324,10 @@ 
 define('FORM_LEFT_OFFSET', 'col-sm-offset-4');
 define('FORM_RIGHT_CLASS', 'col-sm-8');
 
+/**
+ * @param string $label
+ * @param string $name
+ */
 function form_input_text($label, $name, $value='', $type='text', $attrs='', $extra='') {
     echo sprintf('
         <div class="form-group">
@@ -343,6 +370,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">
@@ -387,6 +419,9 @@ 
 
 // $items is list of (name, label, checked)
 //
+/**
+ * @param string $label
+ */
 function form_checkboxes($label, $items, $attrs='') {
     echo sprintf('
         <div class="form-group">
@@ -434,6 +469,10 @@ 
     ';
 }
 
+/**
+ * @param string $label
+ * @param string $item
+ */
 function form_general($label, $item) {
     echo '
         <div class="form-group">
@@ -456,6 +495,9 @@ 
 ';
 }
 
+/**
+ * @param string $text
+ */
 function form_submit($text, $attrs='') {
     form_general(
         "",

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