BOINC / boinc

drupal/sites/default/boinc/modules/contrib/wysiwyg/wysiwyg.module

Doc Comments +6 added lines, -4 removed lines

@@ -674,6 +674,7 @@ 
 
 /**
  * Remove a profile from the database.
+ * @param stdClass $wysiwyg
  */
 function wysiwyg_profile_delete($wysiwyg) {
   if (!isset($wysiwyg->format)) {
@@ -922,7 +923,7 @@ 
  *   Whether to prefix the resulting path with base_path().
  *
  * @return
- *   The path to the specified library.
+ string   The path to the specified library.
  *
  * @ingroup libraries
  */
@@ -1014,7 +1015,7 @@ 
 /**
  * Return a list of directories by modules implementing wysiwyg_include_directory().
  *
- * @param $plugintype
+ * @param string $plugintype
  *   The type of a plugin; can be 'editors'.
  *
  * @return
@@ -1039,10 +1040,11 @@ 
  *
  * @param $module
  *   The module that owns the hook.
- * @param $identifier
+ * @param string $identifier
  *   Either the module or 'wysiwyg_' . $file->name
- * @param $hook
+ * @param string $hook
  *   The name of the hook being invoked.
+ * @param string $path
  */
 function _wysiwyg_process_include($module, $identifier, $path, $hook) {
   $function = $identifier . '_' . $hook;

html/inc/account.inc

Doc Comments +7 added lines

@@ -18,6 +18,10 @@ 
 
 // forms for account creation and login
 
+/**
+ * @param integer $teamid
+ * @param string $next_url
+ */
 function create_account_form($teamid, $next_url) {
     global $recaptcha_public_key;
     echo "
@@ -92,6 +96,9 @@ 
     echo "</form>\n";
 }
 
+/**
+ * @param string $next_url
+ */
 function login_form($next_url) {
     echo "
         <form name=\"f\" method=\"post\" action=\"".secure_url_base()."/login_action.php\">

html/inc/akismet.inc

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
     }
 }
 
+/**
+ * @param string $path
+ */
 function akismet_request($request, $host, $path, $port = 80) {
     $http_request  = "POST $path HTTP/1.0\r\n";
     $http_request .= "Host: $host\r\n";

html/inc/boinc_db.inc

Doc Comments +107 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);
@@ -766,6 +863,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);
@@ -780,6 +882,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/bolt.inc

Doc Comments +9 added lines

@@ -246,6 +246,9 @@ 
 
 }
 
+/**
+ * @param string $n
+ */
 function name($n) {
     return array('name', $n);
 }
@@ -254,10 +257,16 @@ 
     return array('title', $n);
 }
 
+/**
+ * @param integer $n
+ */
 function number($n) {
     return array('number', $n);
 }
 
+/**
+ * @param string $n
+ */
 function filename($n) {
     return array('filename', $n);
 }

html/inc/bolt_ex.inc

Doc Comments +8 added lines

@@ -240,6 +240,10 @@ 
 
 class BoltFitbField {
     public $textarea, $nrows, $ncols;
+
+    /**
+     * @param boolean $textarea
+     */
     function __construct($textarea, $nrows, $ncols) {
         $this->textarea = $textarea;
         $this->nrows = $nrows;
@@ -258,6 +262,10 @@ 
 class BoltFitbAnswer {
     public $type;   // 0=constant, 1=regexp, 2=func
     public $ans;
+
+    /**
+     * @param integer $type
+     */
     function __construct($type, $ans) {
         $this->type = $type;
         $this->ans = $ans;

html/inc/bolt_select.inc

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
     }
 }
 
+/**
+ * @param string $n
+ */
 function valuator($n) {
     return array('valuator', $n);
 }

html/inc/bolt_snap.inc

Doc Comments +6 added lines

@@ -45,6 +45,9 @@ 
     return "../bolt_snap/compare_snapshot_$x";
 }
 
+/**
+ * @param null|integer $dur
+ */
 function write_compare_snapshot($course_id, $select_name, $xset_name, $dur) {
     $now = time();
     $start = $now - $dur*86400;
@@ -127,6 +130,9 @@ 
     return "../bolt_snap/map_snapshot_".$course_id;
 }
 
+/**
+ * @param null|integer $dur
+ */
 function write_map_snapshot($course_id, $dur) {
     $now = time();
     $start = $now - $dur*86400;

html/inc/bolt_util_ops.inc

Doc Comments +21 added lines

@@ -23,6 +23,9 @@ 
 
 // get names of units of a given type
 
+/**
+ * @param string $type
+ */
 function units_of_type($unit, $type) {
     $names = array();
     if (get_class($unit) == $type) {
@@ -118,6 +121,10 @@ 
 
 //////////// graph drawing
 
+/**
+ * @param integer $n
+ * @param integer $width
+ */
 function compare_bar($title, $n, $width, $lo, $hi) {
     $x1 = $width*$lo;
     $x2 = $width*($hi-$lo);
@@ -137,6 +144,9 @@ 
     ";
 }
 
+/**
+ * @param integer $width
+ */
 function compare_bar_insuff($title, $width) {
     return "
         <tr>
@@ -150,6 +160,10 @@ 
     ";
 }
 
+/**
+ * @param integer[] $x
+ * @param integer $width
+ */
 function outcome_graph($x, $width) {
     $n = $x[0]+$x[1]+$x[2];
     if (!$n) return empty_cell();
@@ -182,6 +196,9 @@ 
     return $s;
 }
 
+/**
+ * @param integer $w
+ */
 function time_graph($t, $w) {
     if ($t == 0) return "<td>---</td>";
     $x = (log10($t)+2)*$w/4;
@@ -193,6 +210,10 @@ 
     </td>";
 }
 
+/**
+ * @param integer $t
+ * @param integer $w
+ */
 function score_graph($t, $w) {
     if ($t == 0) return "<td>---</td>";
     $x = $t*$w;