BOINC / boinc

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/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_basic.inc

Doc Comments +16 added lines

@@ -36,6 +36,10 @@ 
     return file_exists("$d/stop_sched");
 }
 
+/**
+ * @param string $x
+ * @param string $y
+ */
 function show_page($x, $y) {
     echo "
         <title>$x</title>
@@ -44,6 +48,9 @@ 
     ";
 }
 
+/**
+ * @param integer $num
+ */
 function xml_error($num, $msg=null, $file=null, $line=null) {
     global $xml_outer_tag;
     if (!$msg) {
@@ -92,6 +99,9 @@ 
 // Look for an element in a line of XML text
 // If it's a single-tag element, and it's present, just return the tag
 //
+/**
+ * @return string
+ */
 function parse_element($xml, $tag) {
     $element = null;
     $closetag = "</" . substr($tag,1);
@@ -107,6 +117,9 @@ 
     return trim($element);
 }
 
+/**
+ * @param string $tag
+ */
 function parse_next_element($xml, $tag, &$cursor) {
     $element = null;
     $closetag = "</" . substr($tag,1);
@@ -137,6 +150,9 @@ 
 
 // look for a particular element in the config file
 //
+/**
+ * @param string $tag
+ */
 function parse_config($config, $tag) {
     $element = parse_element($config, $tag);
     return $element;

html/inc/boinc_db.inc

Doc Comments +117 added lines

@@ -40,6 +40,10 @@ 
     // 2: only use replica_db_user, only try replica_db_host
     // can be set projectwide using <replica_fallback_mode>
     //
+
+    /**
+     * @param boolean $readonly
+     */
     static function get_aux($readonly, $fallback_mode = 0) {
         $config = get_config();
         $user = parse_config($config, '<db_user>');
@@ -204,6 +208,10 @@ 
         $db = BoincDb::get();
         return $db->count('user', $clause);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('user', $field);
@@ -216,6 +224,10 @@ 
         $db = BoincDb::get();
         return $db->enum('user', 'BoincUser', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -233,10 +245,19 @@ 
         $db->delete_aux('profile', "userid=$this->id");
         return $db->delete($this, 'user');
     }
+
+    /**
+     * @param string $field
+     */
     static function sum($field) {
         $db = BoincDb::get();
         return $db->sum('user', $field);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('user', $field, $clause, $pct);
@@ -245,6 +266,10 @@ 
 
 class BoincTeam {
     static $cache;
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('team', $clause);
@@ -282,14 +307,27 @@ 
         $db = BoincDb::get();
         return $db->delete($this, 'team');
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('team', $field, $clause, $pct);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('team', $field);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -326,6 +364,12 @@ 
         $db = BoincDb::get();
         return $db->enum('host', 'BoincHost', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -358,6 +402,10 @@ 
         $db = BoincDb::get();
         return $db->enum('result', 'BoincResult', $where_clause);
     }
+
+	/**
+	 * @param string $fields
+	 */
 	static function enum_fields($fields, $where_clause, $order_clause) {
         $db = BoincDb::get();
 		return $db->enum_fields('result', 'BoincResult', $fields, $where_clause, $order_clause);
@@ -412,6 +460,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('workunit', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function count($clause) {
         $db = BoincDb::get();
         return $db->count('workunit', $clause);
@@ -427,6 +479,10 @@ 
         $db = BoincDb::get();
         return $db->lookup('app', 'BoincApp', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('app', 'BoincApp', $where_clause);
@@ -441,6 +497,11 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'app', $clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause=null) {
         $db = BoincDb::get();
         return $db->sum('app', $field, $clause);
@@ -473,6 +534,10 @@ 
 }
 
 class BoincProfile {
+
+    /**
+     * @param string $fields
+     */
     static function lookup_fields($fields, $clause) {
         $db = BoincDb::get();
         return $db->lookup_fields('profile', 'BoincProfile', $fields, $clause);
@@ -489,18 +554,37 @@ 
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause.' where userid='.$this->userid);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         return $db->insert('profile', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum($where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum('profile', 'BoincProfile', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields('profile', 'BoincProfile', $fields, $where_clause, $order_clause);
@@ -568,6 +652,10 @@ 
 }
 
 class BoincPlatform {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('platform', 'BoincPlatform', $where_clause);
@@ -648,6 +736,10 @@ 
 }
 
 class BoincBadge {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('badge', 'BoincBadge', $where_clause);
@@ -743,6 +835,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_user', 'BoincCreditUser', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_user', $field, $clause);
@@ -755,6 +852,11 @@ 
         $db = BoincDb::get();
         $db->delete_aux('credit_user', "userid=$user->id");
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('user', 'credit_user', 'id', 'userid', 'BoincCreditUser', '*', $where_clause, $order_clause, $limit);
@@ -770,6 +872,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_team', 'BoincCreditTeam', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_team', $field, $clause);
@@ -778,6 +885,11 @@ 
         $db = BoincDb::get();
         return $db->update_aux('credit_team', $clause);
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('team', 'credit_team', 'id', 'teamid', 'BoincCreditTeam', '*', $where_clause, $order_clause, $limit);
@@ -788,6 +900,11 @@ 
 // 
 // apply this to any user-supplied strings used in queries
 // 
+/**
+ * @param string $x
+ *
+ * @return string
+ */
 function boinc_real_escape_string($x) {
     if (version_compare(phpversion(),"4.3.0")>=0) {
         return BoincDb::escape_string($x);

html/inc/db_conn.inc

Doc Comments +58 added lines

@@ -26,6 +26,9 @@ 
     var $db_name;
     var $readonly;
 
+    /**
+     * @param boolean $readonly
+     */
     function init_conn($user, $passwd, $host, $name, $readonly) {
         if (MYSQLI) {
             $x = explode(":", $host);
@@ -92,6 +95,14 @@ 
         }
     }
 
+    /**
+     * @param string $table1
+     * @param string $table2
+     * @param string $joinfield1
+     * @param string $joinfield2
+     * @param string $classname
+     * @param string $fields
+     */
     function get_list($table1, $table2, $joinfield1, $joinfield2, $classname, $fields, $where_clause, $order_clause, $limit) {
         $query = "select $fields from DBNAME.$table1 a join DBNAME.$table2 b on a.$joinfield1=b.$joinfield2 where $where_clause order by $order_clause desc limit $limit";
         $result = $this->do_query($query);
@@ -131,6 +142,10 @@ 
         return $this->lookup_fields($table, $classname, "*", $clause);
     }
 
+    /**
+     * @param string $table
+     * @param string $classname
+     */
     function lookup_id($id, $table, $classname) {
         $id = (int)$id;
         return $this->lookup($table, $classname, "id=$id");
@@ -165,28 +180,51 @@ 
         return $this->enum_general($classname,$query);
     }
 
+    /**
+     * @param string $table
+     * @param string $classname
+     */
     function enum($table, $classname, $where_clause=null, $order_clause=null) {
         return self::enum_fields(
             $table, $classname, '*', $where_clause, $order_clause
         );
     }
 
+    /**
+     * @param string $table
+     */
     function update($obj, $table, $clause) {
         $query = "update DBNAME.$table set $clause where id=$obj->id";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function update_aux($table, $clause) {
         $query = "update DBNAME.$table set $clause";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function insert($table, $clause) {
         $query = "insert into DBNAME.$table $clause";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function delete($obj, $table) {
         $query = "delete from DBNAME.$table where id=$obj->id";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function delete_aux($table, $clause) {
         $query = "delete from DBNAME.$table where $clause";
         return $this->do_query($query);
@@ -198,6 +236,10 @@ 
             return mysql_insert_id($this->db_conn);
         }
     }
+
+    /**
+     * @param string $field
+     */
     function get_int($query, $field) {
         $result = $this->do_query($query);
         if (!$result) error_page("database error on query $query");
@@ -228,14 +270,26 @@ 
         $query = "select count(*) as total from DBNAME.$table where $clause";
         return $this->get_int($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function sum($table, $field, $clause="") {
         $query = "select sum($field) as total from DBNAME.$table $clause";
         return $this->get_double($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function max($table, $field, $clause="") {
         $query = "select max($field) as total from DBNAME.$table $clause";
         return $this->get_double($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function percentile($table, $field, $clause, $pct) {
         $n = $this->count($table, $clause);
         if (!$n) return false;
@@ -243,6 +297,10 @@ 
         $query = "select $field from DBNAME.$table where $clause order by $field limit $m,1";
         return $this->get_double($query, $field);
     }
+
+    /**
+     * @param string $table
+     */
     function replace($table, $clause) {
         $query = "replace into DBNAME.$table set $clause";
         return $this->do_query($query);