BOINC / boinc

html/inc/result.inc

Doc Comments +15 added lines

@@ -53,6 +53,9 @@ 
     return $platforms[$id];
 }
 
+/**
+ * @param string $rsc_name
+ */
 function anon_platform_string($result, $rsc_name=null) {
     $app = get_app($result->appid);
     $n = $app->user_friendly_name."<br>".  tra("Anonymous platform");
@@ -92,6 +95,9 @@ 
     return "$n v$v $c<br>$platform->name";
 }
 
+/**
+ * @param string $string_to_show
+ */
 function result_granted_credit_string($result, $string_to_show) {
     if ($result->server_state == RESULT_SERVER_STATE_IN_PROGRESS && $result->granted_credit > 0) {
         return $string_to_show;
@@ -356,6 +362,10 @@ 
     return "results.php?$c&amp;offset=$o&amp;show_names=$sn&amp;state=$st&amp;appid=$appid";
 }
 
+/**
+ * @param boolean $show_wu_link
+ * @param boolean $show_host_link
+ */
 function result_table_start($show_wu_link, $show_host_link, $info) {
     start_table('table-striped');
     $x = array();
@@ -417,6 +427,11 @@ 
     return false;
 }
 
+/**
+ * @param boolean $show_wu_link
+ * @param boolean $show_host_link
+ * @param boolean $show_name
+ */
 function show_result_row($result, $show_wu_link, $show_host_link, $show_name) {
     $s = time_str($result->sent_time);
     // if result has been reported, show the received time,

html/inc/sandbox.inc

Doc Comments +12 added lines

@@ -26,6 +26,9 @@ 
 // Create dir if not present.
 //
 if (!function_exists("sandbox_dir")){
+/**
+ * @return string
+ */
 function sandbox_dir($user) {
     $dir = parse_config(get_config(), "<sandbox_dir>");
     if (!$dir) { $dir = "../../sandbox/"; }
@@ -40,12 +43,18 @@ 
 }
 }
 
+/**
+ * @param string $md5
+ */
 function sandbox_write_link_file($path, $size, $md5) {
     file_put_contents($path, "sb $size $md5");
 }
 
 // check if a newly update files already exists in sandbox via its md5 sum
 //
+/**
+ * @param string $md5
+ */
 function sandbox_lf_exist($user, $md5) {
     $exist = 0;
     $elf = "";
@@ -115,6 +124,9 @@ 
 // return a <select> for files in sandbox
 //
 if (!function_exists('sandbox_file_select')) {
+/**
+ * @param string $select_name
+ */
 function sandbox_file_select($user, $select_name, $regexp = null, $allow_none = false) {
     if ($regexp === null) {
         $regexp = $select_name;

html/inc/submit.inc

Doc Comments +24 added lines

@@ -145,6 +145,9 @@ 
     }
 }
 
+/**
+ * @param string $op
+ */
 function do_batch_op($req, $op) {
     $retval = validate_request($req);
     if ($retval) return array(null, $retval);
@@ -172,6 +175,9 @@ 
 
 // if RPC had a fatal error, return the message
 //
+/**
+ * @param string $outer_tag
+ */
 function get_error($reply, $outer_tag) {
     $name = $reply->getName();
     if ($name != $outer_tag) {
@@ -187,6 +193,9 @@ 
 
 //// API functions follow
 
+/**
+ * @param stdClass $req
+ */
 function boinc_estimate_batch($req) {
     list($reply, $errmsg) = do_batch_op($req, "estimate_batch");
     if ($errmsg) return array(0, $errmsg);
@@ -205,6 +214,9 @@ 
     return array((int)$reply->batch_id, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_query_batches($req) {
     $req_xml = "<query_batches>
     <authenticator>$req->authenticator</authenticator>
@@ -255,6 +267,9 @@ 
     return array($r, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_query_job($req) {
     $req_xml = "<query_job>
     <authenticator>$req->authenticator</authenticator>
@@ -285,6 +300,9 @@ 
     return array($r, null);
 }
 
+/**
+ * @return string
+ */
 function boinc_abort_batch($req) {
     $req_xml = "<abort_batch>
     <authenticator>$req->authenticator</authenticator>
@@ -299,6 +317,9 @@ 
     return array(true, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_get_output_file($req) {
     $auth_str = md5($req->authenticator.$req->instance_name);
     $name = $req->instance_name;
@@ -312,6 +333,9 @@ 
     return $req->project."/get_output.php?cmd=batch_files&batch_id=$batch_id&auth_str=$auth_str";
 }
 
+/**
+ * @return string
+ */
 function boinc_retire_batch($req) {
     $req_xml = "<retire_batch>
     <authenticator>$req->authenticator</authenticator>

html/inc/submit_db.inc

Doc Comments +16 added lines

@@ -34,6 +34,10 @@ 
         $db = BoincDb::get();
         return $db->enum('batch', 'BoincBatch', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('batch', $clause);
@@ -44,6 +48,10 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'batch', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('batch', $clause);
@@ -59,6 +67,10 @@ 
 }
 
 class BoincUserSubmit {
+
+    /**
+     * @param string $clause
+     */
     static function enum($clause) {
         $db = BoincDb::get();
         return $db->enum('user_submit', 'BoincUserSubmit', $clause);
@@ -77,6 +89,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('user_submit', "$clause where user_id=$this->user_id");
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('user_submit', $clause);

html/inc/submit_util.inc

Doc Comments +11 added lines

@@ -26,6 +26,9 @@ 
 // we need to give a unique physical name based on its content.
 // Prepend the jf_ to make the origin of the file clear
 //
+/**
+ * @param string $md5
+ */
 function job_file_name($md5) {
     return "jf_$md5";
 }
@@ -179,12 +182,20 @@ 
     return $batch_td_size;
 }
 
+/**
+ * @param integer $i
+ *
+ * @return double
+ */
 function boinc_get_output_file_url($user, $result, $i) {
     $name = $result->name;
     $auth_str = md5($user->authenticator.$name);
     return "get_output.php?cmd=result_file&result_name=$name&file_num=$i&auth_str=$auth_str";
 }
 
+/**
+ * @param null|integer $batch_id
+ */
 function boinc_get_output_files_url($user, $batch_id) {
     $auth_str = md5($user->authenticator.$batch_id);
     return "get_output.php?cmd=batch_files&batch_id=$batch_id&auth_str=$auth_str";

html/inc/team.inc

Doc Comments +6 added lines

@@ -524,6 +524,9 @@ 
 //   an active request, i.e. after the 60 days elapse X has another
 //   30 days to assume foundership before someone elase can request it
 //
+/**
+ * @param integer $now
+ */
 function new_transfer_request_ok($team, $now) {
     if ($team->ping_user <= 0) {
         if ($team->ping_time < $now - 60 * 86400) {
@@ -544,6 +547,9 @@ 
     return $team->ping_time + 60*86400;
 }
 
+/**
+ * @param integer $now
+ */
 function transfer_ok($team, $now) {
     if ($now > transfer_ok_time($team)) return true;
     return false;

html/inc/text_transform.inc

Doc Comments +8 added lines

@@ -105,6 +105,9 @@ 
 
 // handle [pre] and [code] separately because we need to remove <br />s
 //
+/**
+ * @param boolean $export
+ */
 function replace_pre_code($text, $export) {
     if ($export) {
         $text = preg_replace_callback(
@@ -272,6 +275,11 @@ 
 // for example inside <pre> containers
 // The original \n was retained after the br when it was added
 //
+/**
+ * @param string $text
+ *
+ * @return string
+ */
 function remove_br($text){
     return str_replace("<br />", "", $text);
 }

html/inc/time.inc

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 // express a time difference in readable form, e.g. "7 days ago".
 // If it's more than 30 days, just show the date
 //
+/**
+ * @param integer $t2
+ */
 function time_diff_str($t1, $t2) {
     if (!$t1 || !$t2) return "---";
     $diff = $t2 - $t1;

html/inc/translation.inc

Doc Comments +6 added lines

@@ -112,6 +112,9 @@ 
 // @param file The file to parse
 // checking for inconsistencies if needed.
 //
+/**
+ * @param string $file
+ */
 function parse_po_file($file) {
     $translation_file = file($file);
     $first_entry = true;
@@ -157,6 +160,9 @@ 
 
 // Returns the contents of a line (ie removes "" from start and end)
 //
+/**
+ * @param string $line
+ */
 function get_po_line($line, $file) {
     $start = strpos($line, '"')+1;
     $stop = strrpos($line, '"');