BOINC / boinc

html/inc/bossa.inc

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
     return $job->insert($clause);
 }
 
+/**
+ * @param string $name
+ */
 function bossa_batch_create($appid, $name, $calibration) {
     $now = time();
     $c = $calibration?"1":"0";

html/inc/cache.inc

Doc Comments +17 added lines

@@ -59,6 +59,9 @@ 
     return $path;
 }
 
+/**
+ * @param string $dir
+ */
 function disk_usage($dir) {
     $usage=0;
     if ($handle=@opendir($dir)) {
@@ -76,6 +79,10 @@ 
     return $usage;
 }
 
+/**
+ * @param integer $max_age
+ * @param string $dir
+ */
 function clean_cache($max_age, $dir) {
     $start_dir = getcwd();
     if (!chdir($dir)) {
@@ -116,6 +123,9 @@ 
     clean_cache($x, "../cache");
 }
 
+/**
+ * @param string $path
+ */
 function cache_need_to_regenerate($path, $max_age){
     $regenerate = false;
     $request = apache_request_headers();
@@ -139,6 +149,9 @@ 
 }
 
 // Returns cached data or false if nothing was found
+/**
+ * @param integer $max_age
+ */
 function get_cached_data($max_age, $params=""){
     global $no_cache;
 
@@ -253,6 +266,10 @@ 
     }
 }
 
+/**
+ * @param integer $max_age
+ * @param string $data
+ */
 function set_cached_data($max_age, $data, $params=""){
     // for the benefit of hackers
     if (strstr($params, "..")) {

html/inc/cert.inc

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
     $ops = number_format($ops, 2);
 }
 
+/**
+ * @param boolean $bolden
+ */
 function credit_string($credit, $bolden) {
     $cobbs = number_format($credit, 0);
 

html/inc/db.inc

Doc Comments +8 added lines

@@ -69,6 +69,10 @@ 
     function _mysql_fetch_row($r) {
         return mysqli_fetch_row($r);
     }
+
+    /**
+     * @param resource $r
+     */
     function _mysql_fetch_assoc($r) {
         return mysqli_fetch_assoc($r);
     }
@@ -132,6 +136,10 @@ 
     function _mysql_fetch_row($r) {
         return mysql_fetch_row($r);
     }
+
+    /**
+     * @param resource $r
+     */
     function _mysql_fetch_assoc($r) {
         return mysql_fetch_assoc($r);
     }

html/inc/db_conn.inc

Doc Comments +50 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);
@@ -112,6 +115,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");
@@ -146,28 +153,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);
@@ -179,6 +209,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");
@@ -209,14 +243,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;
@@ -224,6 +270,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);

html/inc/db_ops.inc

Doc Comments +26 added lines

@@ -103,6 +103,9 @@ 
 
 // Function prints a description of $table 
 //
+/**
+ * @param integer $which
+ */
 function print_describe_table_onecol($table, $which, $columns) {
     $db = BoincDb::get(true);
     $result = $db->do_query("SELECT * from $table LIMIT 1");
@@ -262,6 +265,10 @@ 
             $this->urlquery .= "&clauses=$clause";
         }
     }
+
+    /**
+     * @param string $name
+     */
     function addeq($name) {
         if (isset($_GET[$name])) {
             $value = $_GET[$name];
@@ -273,6 +280,10 @@ 
             $this->urlquery .= "&$name=".urlencode($value);
         }
     }
+
+    /**
+     * @param string $name
+     */
     function addeq_not_CHOOSE_ALL($name) {
         if (isset($_GET[$name])) {
             $value = $_GET[$name];
@@ -287,6 +298,10 @@ 
             $this->urlquery .= "&$name=".urlencode($value);
         }
     }
+
+    /**
+     * @param string $name
+     */
     function addgt($name) {
         if (isset($_GET[$name])) {
             $value = $_GET[$name];
@@ -298,6 +313,11 @@ 
             $this->urlquery .= "&$name=".urlencode($value);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $order
+     */
     function addsort($name, $order) {
         if (isset($_GET[$name])) {
             $value = $_GET[$name];
@@ -375,6 +395,9 @@ 
 }
 
 
+/**
+ * @param string $mq
+ */
 function link_results($n, $mq, $query, $clauses) {
     if ($n == '0') { // intentional compare by string
         return "0";
@@ -824,6 +847,9 @@ 
     return number_format($x/86400, 2)." days";
 }
 
+/**
+ * @param integer $x
+ */
 function resource_name($x) {
     switch ($x) {
     case 2: return "CPU";

html/inc/dir_hier.inc

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
     return "$dirpath/$filename";
 }
 
+/**
+ * @param string $base
+ */
 function dir_hier_url($filename, $base, $fanout) {
     $dir = filename_hash($filename, $fanout);
     return "$base/$dir/$filename";

html/inc/forum.inc

Doc Comments +15 added lines

@@ -208,6 +208,9 @@ 
 // (to accommodate long [pre] lines)
 // and the left column (author info) has fixed size
 //
+/**
+ * @param string[] $headings
+ */
 function start_forum_table($headings) {
     $a = array();
     foreach ($headings as $h) {
@@ -488,6 +491,9 @@ 
 // Display an individual post.
 // Generates a table row with two cells: author and message
 //
+/**
+ * @param integer $controls
+ */
 function show_post(
     $post, $thread, $forum, $logged_in_user, $latest_viewed,
     $controls=FORUM_CONTROLS, $filter=true
@@ -852,6 +858,9 @@ 
 // These take care of counts and timestamps.
 // Don't do these things directly - use these functions
 //
+/**
+ * @param integer $parent_id
+ */
 function create_post($content, $parent_id, $user, $forum, $thread, $signature) {
     $content = substr($content, 0, 64000);
     $content = BoincDb::escape_string($content);
@@ -1084,6 +1093,9 @@ 
 // $sort_style - string (checked by switch statement)
 // $show_hidden - bool (not directly passed to SQL)
 //
+/**
+ * @param boolean $show_hidden
+ */
 function get_thread_posts($threadid, $sort_style, $show_hidden) {
     $sql = "thread=$threadid";
     if (!$show_hidden) {
@@ -1109,6 +1121,9 @@ 
 // Show links for post moderation actions;
 // logged in user has moderation rights.
 //
+/**
+ * @param string $config
+ */
 function show_post_moderation_links(
     $config, $logged_in_user, $post, $forum, $tokens
 ){

html/inc/forum_db.inc

Doc Comments +20 added lines

@@ -115,6 +115,10 @@ 
         $db = BoincDb::get();
         return $db->enum('post', 'BoincPost', $clause);
     }
+
+    /**
+     * @param string $query
+     */
     static function enum_general($query) {
         $db = BoincDb::get();
         return $db->enum_general('BoincPost', $query);
@@ -175,6 +179,10 @@ 
         $db = BoincDb::get();
         return $db->delete_aux('forum_preferences', "userid=$this->userid");
     }
+
+    /**
+     * @param string $clause
+     */
     static function enum($clause=null) {
         $db = BoincDb::get();
         return $db->enum('forum_preferences', 'BoincForumPrefs', $clause);
@@ -290,6 +298,10 @@ 
 }
 
 class BoincNotify {
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('notify', $clause);
@@ -304,6 +316,10 @@ 
         $db = BoincDb::get();
         return $db->enum('notify', 'BoincNotify', $clause);
     }
+
+    /**
+     * @param integer $type
+     */
     static function lookup($userid, $type, $opaque) {
         $db = BoincDb::get();
         return $db->lookup('notify', 'BoincNotify', "userid=$userid and type=$type and opaque=$opaque");
@@ -316,6 +332,10 @@ 
         $db = BoincDb::get();
         $db->delete_aux('notify', $clause);
     }
+
+    /**
+     * @param string $query
+     */
     static function enum_general($query) {
         $db = BoincDb::get();
         return $db->enum_general('BoincNotify', $query);