BOINC / boinc

html/inc/news.inc

Doc Comments +4 added lines

@@ -65,6 +65,10 @@
     return $forum->parent_type == 0 && ($forum->title === $forum_name);
 }
 
+/**
+ * @param integer $start
+ * @param integer $count
+ */
 function show_news($start, $count) {
     $forum = news_forum();
     if (!$forum) {

html/inc/pm.inc

Doc Comments +13 added lines

@@ -27,6 +27,10 @@ 
     echo "</div>\n";
 }
 
+/**
+ * @param null|integer $teamid
+ * @param string $error
+ */
 function pm_team_form($user, $teamid, $error=null) {
     global $bbcode_html, $bbcode_js;
     $team = BoincTeam::lookup_id($teamid);
@@ -78,6 +82,9 @@ 
     page_tail();
 }
 
+/**
+ * @param string $error
+ */
 function pm_form($replyto, $userid, $error = null) {
     global $bbcode_html, $bbcode_js;
     global $g_logged_in_user;
@@ -196,6 +203,9 @@ 
     return "<a href=pm.php>".tra("Private message%1 from %2, subject:" , "</a>", $from_user->name )." $pm->subject";
 }
 
+/**
+ * @param boolean $send_email
+ */
 function pm_send_msg($from_user, $to_user, $subject, $content, $send_email) {
     $sql_subject = BoincDb::escape_string(sanitize_tags($subject));
     $sql_content = BoincDb::escape_string($content);
@@ -224,6 +234,9 @@ 
     BoincNotify::insert("(userid, create_time, type, opaque) values ($to_user->id, ".time().", ".NOTIFY_PM.", $mid)");
 }
 
+/**
+ * @param integer $duration
+ */
 function pm_count($userid, $duration) {
     $time = time() - $duration;
 

html/inc/prefs.inc

Doc Comments +11 added lines

@@ -291,6 +291,9 @@ 
     return $dp;
 }
 
+/**
+ * @param string $t
+ */
 function group_header($t) {
     echo "<tr><th class=\"bg-info\">$t</th><td class=\"bg-info\" colspan=4><br></td></tr>\n";
 }
@@ -413,6 +416,9 @@ 
 
 // Display all venues as columns next to descriptions
 //
+/**
+ * @param stdClass $prefs
+ */
 function prefs_show_columns_global($prefs) {
     global $cpu_prefs;
     global $disk_prefs;
@@ -483,6 +489,11 @@ 
     return PROJECT;
 }
 
+/**
+ * @param stdClass $prefs
+ * @param string $venue
+ * @param string $subset
+ */
 function prefs_display_venue($prefs, $venue, $subset) {
     global $g_logged_in_user;
     $tokens = url_tokens($g_logged_in_user->authenticator);

html/inc/prefs_project.inc

Doc Comments +3 added lines

@@ -241,6 +241,9 @@
     }
 }
 
+/**
+ * @param boolean $columns
+ */
 function prefs_show_privacy($user, $columns) {
     global $privacy_pref_descs;
     if ($columns) {

html/inc/prefs_util.inc

Doc Comments +17 added lines

@@ -440,6 +440,10 @@ 
     }
 }
 
+/**
+ * @param string $id
+ * @param string $d
+ */
 function hour_select($x, $name, $id, $d) {
     $s = "";
     $s .= "<select class=\"selectbox form-control input-sm\" name=$name id=$id $d>\n";
@@ -533,6 +537,9 @@ 
 
 // display preference subsets as columns
 //
+/**
+ * @param string $x
+ */
 function row_top($x) {
     echo "<tr class=\"bg-primary\"><th width=35%>$x</th>";
     echo "<th ><b>".tra("Default")."</b></th>
@@ -545,6 +552,13 @@ 
 
 // row_defs - Display a value for all 4 venues in one row
 //
+/**
+ * @param string $pre
+ * @param string $item
+ * @param string $post
+ * @param string $type
+ * @param string $tooltip
+ */
 function row_defs($pre, $item, $post, $type, $prefs, $tooltip=null) {
     $gen = $prefs->$item;
     $hom  = (isset($prefs->home) && isset($prefs->home->$item)) ? $prefs->home->$item : "--";
@@ -599,6 +613,9 @@ 
 //
 // row_links - Display Edit/Add/Remove links for all venues in 1 row
 //
+/**
+ * @param string $subset
+ */
 function row_links($subset, $prefs) {
     global $g_logged_in_user;
     $tokens = url_tokens($g_logged_in_user->authenticator);

html/inc/profile.inc

Doc Comments +5 added lines

@@ -114,6 +114,11 @@
     return BoincProfile::delete_aux("userid=$user->id");
 }
 
+/**
+ * @param resource $image
+ * @param integer $targetWidth
+ * @param integer $targetHeight
+ */
 function scale_image(
     $image, $origWidth, $origHeight, $targetWidth, $targetHeight
 ) {

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>