BOINC / boinc

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, '"');

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;

html/inc/util_ops.inc

Doc Comments +17 added lines

@@ -65,10 +65,17 @@ 
          . "<p>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row($x, $y) {
     echo "<tr><td valign=\"top\" align=\"right\">$x</td>\n<td>$y</td>\n</tr>\n";
 }
 
+/**
+ * @param string $color
+ * @param string $x
+ */
 function c_row2($color, $x, $y) {
     echo "<tr bgcolor=\"$color\"><td align=\"right\">$x</td><td>$y</td></tr>\n";
 }
@@ -134,6 +141,9 @@ 
 
 // allow access only if logged in as user in a given set
 //
+/**
+ * @param integer[] $admin_user_ids
+ */
 function auth_ops_userid($admin_user_ids) {
     $user = get_logged_in_user_ops();
     if (!$user) {
@@ -288,6 +298,10 @@ 
 
 ////// badge-related stuff
 
+/**
+ * @param string $name
+ * @param string $title
+ */
 function get_badge($name, $title, $image_url) {
     $b = BoincBadge::lookup("name='$name'");
     if ($b) return $b;
@@ -319,6 +333,9 @@ 
 
 // unassign all badges except the given one
 //
+/**
+ * @param integer $k
+ */
 function unassign_badges($is_user, $item, $badges, $k) {
     $list = null;
     for ($i=0; $i<count($badges); $i++) {

html/inc/web_rpc_api.inc

Doc Comments +14 added lines

@@ -21,6 +21,9 @@ 
 // my PHP currently doesn't support file_get_contents(https://...)
 // so do it with Curl
 //
+/**
+ * @param string $url
+ */
 function fetch_url($url) {
     if (0) {
         return file_get_contents($url);
@@ -35,6 +38,11 @@ 
     }
 }
 
+/**
+ * @param string $project_url
+ * @param string $email_addr
+ * @param string $passwd_hash
+ */
 function lookup_account(
     $project_url,
     $email_addr,
@@ -57,6 +65,12 @@ 
 
 // return (authenticator, errmsg)
 //
+/**
+ * @param string $project_url
+ * @param string $email_addr
+ * @param string $passwd_hash
+ * @param string $user_name
+ */
 function create_account(
     $project_url,
     $email_addr,

html/inc/xml.inc

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
 
 $xml_outer_tag = "";
 
+/**
+ * @param string $tag
+ */
 function xml_start_tag($tag) {
     global $xml_outer_tag;
     echo "<$tag>\n";