BOINC / boinc

html/project.sample/project.inc

Doc Comments +9 added lines

@@ -108,6 +108,10 @@ 
 // If you include any links, prepend URL with $prefix
 // if you need to open divs here close them in project_footer()
 //
+/**
+ * @param string $prefix
+ * @param boolean $is_main
+ */
 function project_banner($title, $prefix, $is_main) {
     if ($is_main) {
         echo '<img class="img-responsive" src="img/water.jpg">';
@@ -119,6 +123,11 @@ 
 }
 //$fixed_navbar = true;
 
+/**
+ * @param boolean $show_return
+ * @param boolean $show_date
+ * @param string $prefix
+ */
 function project_footer($show_return, $show_date, $prefix) {
     // If you include any links, prepend URL with $prefix
     //

html/project.sample/project_specific_prefs.inc

Doc Comments +16 added lines

@@ -32,6 +32,9 @@ 
 //      Parse form variables into XML, and return it.
 //      Also error-check values, and return errors in $errors->*
 
+/**
+ * @param string $name
+ */
 function option($name, $val) {
     $x = ($name == $val) ?  "selected" : "";
     return "<option name='$name' $x>$name\n";
@@ -90,6 +93,10 @@ 
     return $x;
 }
 
+/**
+ * @param string $name
+ * @param integer $max
+ */
 function number_select($name, $max, $n) {
     $sel = ($n == 0) ? "selected":"";
     $x = "<select class=\"form-control input-sm\" name=$name> <option value=0 $sel>".tra("No limit")."</option>";
@@ -106,6 +113,9 @@ 
     return tra("No limit");
 }
 
+/**
+ * @param stdClass $prefs
+ */
 function project_specific_prefs_edit($prefs, $error=false) {
     global $app_array;
     if (COLOR_PREFS) {
@@ -162,6 +172,9 @@ 
     }
 }
 
+/**
+ * @param boolean $error
+ */
 function project_specific_prefs_parse_form(&$error) {
     global $app_array;
     $x = "";
@@ -216,6 +229,9 @@ 
     return $x;
 }
 
+/**
+ * @param stdClass $prefs
+ */
 function project_specific_prefs_show($prefs, $columns=false) {
     global $app_array;
     if ($columns) {

html/user/bolt_sched.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
 require_once("../inc/bolt_util.inc");
 require_once("../inc/util.inc");
 
+/**
+ * @param string $tag
+ */
 function debug_show_state($state, $tag) {
     global $user;
     global $refresh;
@@ -82,6 +85,9 @@ 
 
 // A page is being shown to the user; make a record of it
 //
+/**
+ * @param integer $mode
+ */
 function create_view($iter, $mode, $prev_view_id) {
     global $user;
     global $course;

html/user/create_profile.php

Doc Comments +10 added lines

@@ -31,6 +31,10 @@ 
 // If $selection is provided, and if it matches one of the entries in the file,
 // it will be selected by default.
 //
+/**
+ * @param string $name
+ * @param string $filename
+ */
 function show_combo_box($name, $filename, $selection=null) {
     echo "<select name=\"$name\" class=\"form-control\">\n";
 
@@ -185,6 +189,9 @@ 
     show_language_selection($profile);
 }
 
+/**
+ * @param string $name
+ */
 function show_textarea($name, $text) {
     rowify("<textarea name=\"$name\" class=\"form-control\" rows=\"10\">" . $text . "</textarea>");
 }
@@ -311,6 +318,9 @@ 
     page_tail();
 }
 
+/**
+ * @param string $warning
+ */
 function show_profile_form($profile, $warning=null) {
     if ($profile) {
         page_head(tra("Edit your profile"), null, null, null, boinc_recaptcha_get_head_extra());

html/user/forum_reply.php

Doc Comments +3 added lines

@@ -178,6 +178,9 @@
     row2($x1, $x2, false, "20%");
 }
 
+/**
+ * @param string $text
+ */
 function quote_text($text) {
     $text = "[quote]" . $text . "[/quote]";
     return $text;

html/user/gpu_list.php

Doc Comments +10 added lines

@@ -29,6 +29,9 @@ 
 // take a host.serialnum field (which may encode several GPUs)
 // and extract the model name for the given vendor
 //
+/**
+ * @param string $vendor
+ */
 function get_gpu_model($x, $vendor) {
     $descs = explode("]", $x);
     array_pop($descs);
@@ -60,6 +63,10 @@ 
 // $x->linux
 // $x->mac
 //
+/**
+ * @param string $vendor
+ * @param string $alt_vendor
+ */
 function get_gpu_list($vendor, $alt_vendor=null) {
     $clause = "plan_class like '%$vendor%'";
     if ($alt_vendor) {
@@ -144,6 +151,9 @@ 
     return $x1->avg_time > $x2->avg_time;
 }
 
+/**
+ * @param string $name
+ */
 function show_list($models, $name) {
     echo "<td><h2>$name</h2>\n";
     if (!count($models)) {

html/user/host_app_versions.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
 
 require_once("../inc/util.inc");
 
+/**
+ * @param integer $t
+ */
 function rsc_name($t) {
     switch ($t) {
     case 2: return tra("CPU");

html/user/host_edit_action.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 require_once("../inc/util.inc");
 require_once("../inc/host.inc");
 
+/**
+ * @param string $msg
+ */
 function fail($msg) {
     echo "Error: $msg";
     page_tail();

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;