BOINC / boinc

html/user/lammps.php

Doc Comments +26 added lines

@@ -30,6 +30,9 @@ 
 //
 // output: success flag, CPU time per step, est. disk usage per job
 //
+/**
+ * @param resource $p
+ */
 function terminate_job($p) {
     $pstatus=proc_get_status($p);
     $ppid=$pstatus['pid'];
@@ -86,6 +89,9 @@ 
     return array($test_result, $total_cpu, $disk_space);
 }
 
+/**
+ * @param string $cmd_file
+ */
 function get_total_steps($cmd_file) {
     $fd = fopen($cmd_file,"r");
     if (!$fd) {
@@ -116,6 +122,9 @@ 
     return $total_steps;
 }
 
+/**
+ * @param string $filename
+ */
 function calc_step_cpu($filename) {
     $fd = fopen("$filename", "r");
     $start_line = "Step CPU ";
@@ -169,6 +178,11 @@ 
     return array($avg_cpu,$test_steps);
 }
 
+/**
+ * @param string $lammps_script
+ * @param string $structure_file
+ * @param string $cmd_file
+ */
 function calc_est_size($lammps_script, $structure_file, $cmd_file,$test_steps){
     $dump_types = 0;
     $fd = fopen($lammps_script,"r");
@@ -280,6 +294,11 @@ 
 
 // verify that an input file exists in sandbox, and return its physical path
 //
+/**
+ * @param string $name
+ *
+ * @return string
+ */
 function get_file_path($user, $name) {
     $fname = get_str($name);
 
@@ -308,6 +327,10 @@ 
 //
 // Note: these are both extremely optimistic estimates
 //
+/**
+ * @param integer $njobs
+ * @param double $flops_per_job
+ */
 function estimated_makespan($njobs, $flops_per_job) {
     $nhosts = BoincHost::count("expavg_credit > 1");
     if ($nhosts < 10) {
@@ -416,6 +439,9 @@ 
     page_tail();
 }
 
+/**
+ * @param integer $i
+ */
 function submit_job($app, $batch_id, $info, $cmdline, $i) {
     $client_disk=$info->rsc_disk_bound*2;
     if($client_disk<500000000) $client_disk=500000000;

html/user/openid.php

Doc Comments +11 added lines, -1 removed lines

@@ -315,6 +315,11 @@ 
     /**
      * Helper function used to scan for <meta>/<link> tags and extract information
      * from them
+     * @param string $tag
+     * @param string $attrName
+     * @param string $attrValue
+     * @param string $valueName
+     * @return string
      */
     protected function htmlTag($content, $tag, $attrName, $attrValue, $valueName)
     {
@@ -531,6 +536,9 @@ 
         return $params;
     }
 
+    /**
+     * @param boolean $immediate
+     */
     protected function authUrl_v1($immediate)
     {
 	$returnUrl = $this->returnUrl;
@@ -552,6 +560,9 @@ 
                                , array('query' => http_build_query($params, '', '&')));
     }
 
+    /**
+     * @param boolean $immediate
+     */
     protected function authUrl_v2($immediate)
     {
         $params = array(
@@ -587,7 +598,6 @@ 
     /**
      * Returns authentication url. Usually, you want to redirect your user to it.
      * @return String The authentication url.
-     * @param String $select_identifier Whether to request OP to select identity for an user in OpenID 2. Does not affect OpenID 1.
      * @throws ErrorException
      */
     function authUrl($immediate = false)

html/user/server_status.php

Doc Comments +17 added lines

@@ -88,17 +88,26 @@ 
 ";
 }
 
+/**
+ * @param string $name
+ */
 function item_xml($name, $val) {
     if (!$val) $val = 0;
     echo "   <$name>$val</$name>\n";
 }
 
+/**
+ * @param string $name
+ */
 function item_html($name, $val) {
     $name = tra($name);
     echo "<tr><td>$name</td><td>$val</td></tr>\n";
     //echo "<tr><td align=right>$name</td><td align=right>$val</td></tr>\n";
 }
 
+/**
+ * @param stdClass $x
+ */
 function show_status_html($x) {
     page_head(tra("Project status"));
     $j = $x->jobs;
@@ -190,6 +199,9 @@ 
     page_tail();
 }
 
+/**
+ * @param stdClass $x
+ */
 function show_status_xml($x) {
     xml_header();
     echo "<server_status>\n<daemon_status>\n";
@@ -239,6 +251,11 @@ 
 ";
 }
 
+/**
+ * @param string $cmd
+ * @param string $pidname
+ * @param string $host
+ */
 function local_daemon_running($cmd, $pidname, $host) {
     if (!$pidname) {
         $cmd = trim($cmd);

html/user/show_coproc.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
 
 check_get_args(array("mode"));
 
+/**
+ * @param string $mode
+ */
 function filename($mode) {
     switch ($mode) {
     case 'host': return "cuda_hosts.dat";

html/user/submit.php

Doc Comments +9 added lines

@@ -37,6 +37,9 @@ 
     return $n;
 }
 
+/**
+ * @param integer $state
+ */
 function show_all_link($batches, $state, $limit, $user, $app) {
     $n = state_count($batches, $state);
     if ($n > $limit) {
@@ -269,6 +272,9 @@ 
     page_tail();
 }
 
+/**
+ * @param null|integer $app_id
+ */
 function check_admin_access($user, $app_id) {
     $user_submit = BoincUserSubmit::lookup_userid($user->id);
     if (!$user_submit) error_page("no access");
@@ -523,6 +529,9 @@ 
     page_tail();
 }
 
+/**
+ * @param null|integer $state
+ */
 function show_batches_in_state($batches, $state) {
     switch ($state) {
     case BATCH_STATE_IN_PROGRESS:

html/user/submit_rpc_handler.php

Doc Comments +25 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,10 @@ 
 
 // submit a list of jobs with a single create_work command.
 //
+/**
+ * @param SimpleXMLElement|null $template
+ * @param double $priority
+ */
 function submit_jobs(
     $jobs, $template, $app, $batch_id, $priority,
     $result_template_file,      // batch-level; can also specify per job
@@ -267,6 +283,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)) {
@@ -283,6 +302,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)) {
@@ -468,6 +490,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/user/team_forum.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
     edit_form($user, $team, $forum, true);
 }
 
+/**
+ * @param boolean $first
+ */
 function edit_form($user, $team, $forum, $first) {
     page_head(tra("Team Message Board"));
     echo "

html/user/team_search.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 // list entries are of the form id => team,
 // where team includes a field "refcnt".
 // 
+/**
+ * @param integer $weight
+ */
 function merge_lists($list1, &$list2, $weight) {
     foreach($list1 as $team) {
         $id = $team->id;

html/inc/util.inc

Doc Comments +52 added lines

@@ -106,6 +106,9 @@ 
     return secure_url_base();
 }
 
+/**
+ * @param string $name
+ */
 function send_cookie($name, $value, $permanent, $ops=false) {
     global $master_url;
 
@@ -188,6 +191,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.
@@ -455,6 +461,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>
@@ -466,6 +475,9 @@ 
     echo "<tr><td>$x</td><td>$y</td></tr>\n";
 }
 
+/**
+ * @param string $string
+ */
 function rowify($string) {
     echo "<tr><td>$string</td></tr>";
 }
@@ -491,6 +503,9 @@ 
     echo "</tr>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row_heading($x) {
     echo '<tr><th class="bg-primary" colspan=99>'.$x.'</th></tr>
     ';
@@ -555,6 +570,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;
@@ -605,6 +625,9 @@ 
     ob_implicit_flush(0);
 }
 
+/**
+ * @param string $filename
+ */
 function close_output_buffer($filename) {
     $fh = fopen($filename, "w");
     $page = ob_get_contents();
@@ -673,6 +696,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;
@@ -772,6 +798,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.'">"';
 
@@ -833,6 +862,9 @@ 
     ";
 }
 
+/**
+ * @param string $text
+ */
 function button_text($url, $text, $desc=null, $class="btn btn-default") {
     if (!$desc) $desc = $text;
     return "<a href=\"".$url."\" title=\"$desc\" class=\"".$class."\">".$text."</a>
@@ -854,6 +886,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) {
@@ -969,6 +1007,9 @@ 
     }
 }
 
+/**
+ * @param integer $f
+ */
 function flops_to_credit($f) {
     return $f*(200/86400e9);
 }
@@ -1004,6 +1045,9 @@ 
     }
 }
 
+/**
+ * @param integer $height
+ */
 function badges_string($is_user, $item, $height) {
     if (DISABLE_BADGES) return null;
     if ($is_user) {
@@ -1020,6 +1064,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);
@@ -1064,6 +1111,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);\"