BOINC / boinc

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);

html/inc/forum_email.inc

Doc Comments +4 added lines

@@ -196,6 +196,10 @@
 
 //////////////////// a banishment vote has been started  ///////////
 //
+/**
+ * @param integer $duration
+ * @param integer $end_time
+ */
 function send_banish_vote_email($user, $duration, $reason, $end_time) {
 	global $master_url;
     $now=time();

html/inc/forum_rss.inc

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
     return false;
 }
 
+/**
+ * @param boolean $no_images
+ */
 function show_forum_rss_item($thread, $userid, $threads_only, $no_images) {
     $unique_url=secure_url_base()."forum_thread.php?id=".$thread->id;
 

html/inc/geoip.inc

Doc Comments +13 added lines

@@ -229,6 +229,9 @@ 
   shmop_close ($shmid);
 }
 
+/**
+ * @param GeoIP $gi
+ */
 function _setup_segments($gi){
   $gi->databaseType = GEOIP_COUNTRY_EDITION;
   $gi->record_length = STANDARD_RECORD_LENGTH;
@@ -311,6 +314,10 @@ 
   return $gi;
 }
 
+/**
+ * @param string $filename
+ * @param integer $flags
+ */
 function geoip_open($filename, $flags) {
   $gi = new GeoIP;
   $gi->flags = $flags;
@@ -419,6 +426,9 @@ 
   return false;
 }
 
+/**
+ * @param integer $ipnum
+ */
 function _get_org($gi,$ipnum){
   $seek_org = _geoip_seek_country($gi,$ipnum);
   if ($seek_org == $gi->databaseSegments) {
@@ -443,6 +453,9 @@ 
   return _get_org($gi, $ipnum);
 }
 
+/**
+ * @param integer $ipnum
+ */
 function _get_region($gi,$ipnum){
   if ($gi->databaseType == GEOIP_REGION_EDITION_REV0){
     $seek_region = _geoip_seek_country($gi,$ipnum) - GEOIP_STATE_BEGIN_REV0;

html/inc/host.inc

Doc Comments +14 added lines

@@ -324,6 +324,11 @@ 
 // so it's OK to show the domain name etc.
 // If private is false, show the owner's name only if they've given permission
 //
+/**
+ * @param integer $i
+ * @param boolean $show_owner
+ * @param boolean $any_product_name
+ */
 function show_host_row($host, $i, $private, $show_owner, $any_product_name) {
     $anonymous = false;
     if (!$private) {
@@ -503,6 +508,9 @@ 
 // that their time intervals are disjoint.
 // So the CPU/OS checks don't have to be very strict.
 //
+/**
+ * @param boolean $show_detail
+ */
 function hosts_compatible($host1, $host2, $show_detail) {
     // A host is "new" if it has no credit and no results.
     // Skip disjoint-time check if one host or other is new
@@ -642,6 +650,9 @@ 
     return "hosts_user.php?sort=$sort&rev=$rev&show_all=$show_all$x";
 }
 
+/**
+ * @param string $sort
+ */
 function link_url_rev($actual_sort, $sort, $rev, $show_all) {
     if ($actual_sort == $sort) {
         $rev = 1 - $rev;
@@ -661,6 +672,9 @@ 
     echo "<p>";
 }
 
+/**
+ * @param boolean $any_product_name
+ */
 function user_host_table_start(
     $private, $sort, $rev, $show_all, $any_product_name
 ) {

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);