BOINC / boinc

html/inc/bootstrap.inc

Doc Comments +47 added lines

@@ -30,6 +30,11 @@ 
 // $brand: the text or image to show at left of navbar
 // If text, put it in <a class="navbar-brand" ...
 //
+/**
+ * @param string $brand
+ * @param boolean $fixed
+ * @param boolean $inverse
+ */
 function navbar_start($brand, $fixed, $inverse) {
     global $fixed_navbar;
     $class = "navbar";
@@ -99,6 +104,9 @@ 
 
 // add a dropdown menu
 //
+/**
+ * @param string $name
+ */
 function navbar_menu($name, $items) {
     echo '
       <li class="dropdown">
@@ -218,6 +226,10 @@ 
 // output a panel.
 // $content_func is a function that generates the panel contents
 //
+/**
+ * @param string|null $title
+ * @param Closure $content_func
+ */
 function panel($title, $content_func, $class="panel-primary") {
     echo sprintf('<div class="panel %s">
         ', $class
@@ -244,6 +256,11 @@ 
 // are functions that generate the top, left, and right content
 // $left_width is the width of left column in 1/12 units.
 //
+/**
+ * @param boolean $top_func
+ * @param Closure $left_func
+ * @param Closure $right_func
+ */
 function grid($top_func, $left_func, $right_func, $left_width=6) {
     echo '
         <div class="container-fluid">
@@ -277,6 +294,9 @@ 
     ';
 }
 
+/**
+ * @param string $action
+ */
 function form_start($action, $method='get') {
     echo sprintf(
         '<div class="container">
@@ -286,6 +306,9 @@ 
     );
 }
 
+/**
+ * @param string $name
+ */
 function form_input_hidden($name, $value) {
     echo '<input type="hidden" name="'.$name.'" value="'.$value.'">
     ';
@@ -301,6 +324,10 @@ 
 define('FORM_LEFT_OFFSET', 'col-sm-offset-4');
 define('FORM_RIGHT_CLASS', 'col-sm-8');
 
+/**
+ * @param string $label
+ * @param string $name
+ */
 function form_input_text($label, $name, $value='', $type='text', $attrs='', $extra='') {
     echo sprintf('
         <div class="form-group">
@@ -343,6 +370,11 @@ 
 
 // $items is either a string of <option> elements, or an array
 //
+/**
+ * @param string $label
+ * @param string $name
+ * @param string $items
+ */
 function form_select($label, $name, $items) {
     echo sprintf('
         <div class="form-group">
@@ -387,6 +419,9 @@ 
 
 // $items is list of (name, label, checked)
 //
+/**
+ * @param string $label
+ */
 function form_checkboxes($label, $items, $attrs='') {
     echo sprintf('
         <div class="form-group">
@@ -414,6 +449,11 @@ 
 
 // $items is list of (value, label)
 //
+/**
+ * @param string $label
+ * @param string $name
+ * @param string $selected
+ */
 function form_radio_buttons($label, $name, $items, $selected) {
     echo sprintf('
         <div class="form-group">
@@ -434,6 +474,10 @@ 
     ';
 }
 
+/**
+ * @param string $label
+ * @param string $item
+ */
 function form_general($label, $item) {
     echo '
         <div class="form-group">
@@ -456,6 +500,9 @@ 
 ';
 }
 
+/**
+ * @param string $text
+ */
 function form_submit($text, $attrs='') {
     form_general(
         "",

drupal/sites/default/boinc/modules/boincuser/includes/boincuser.helpers.inc

Doc Comments +5 added lines

@@ -26,6 +26,8 @@ 
 
 /**
  * Get an image object from a given file and cck field
+ * @param string $field_name
+ * @param string $content_type
  */ 
 function get_cck_image_object($image_path, $field_name, $content_type, $ignore_resolution = FALSE) {
   $field = content_fields($field_name, $content_type); 
@@ -277,6 +279,7 @@ 
 /**
  * Ignore certain paths. Returns true of path is in the
  * paths_to_ignore array of regular expressions patterns.
+ * @param string[] $paths_to_ignore
  */
 function _boincuser_ignore_paths($path, $paths_to_ignore) {
 
@@ -317,6 +320,7 @@ 
 /**
  * Include BOINC code
  * The path from the BOINC html root must be included (e.g. user/file.php)
+ * @param string $file
  */
 function include_boinc($file) {
   if ($include_dir = boinc_get_path()) {
@@ -332,6 +336,7 @@ 
 
 /**
  * Get the BOINC include path
+ * @return string
  */
 function boinc_get_path($type = 'root') {
   $dir = "boinc_{$type}_dir";

html/project.sample/project.inc

Doc Comments +9 added lines

@@ -116,6 +116,10 @@ 
 // If you include any links, prepend URL with $prefix
 // if you need to open divs here close them in project_footer()
 //
+/**
+ * @param string $prefix
+ * @param boolean $is_main
+ */
 function project_banner($title, $prefix, $is_main) {
     if ($is_main) {
         echo '<img class="img-responsive" style="width:100%" src="img/water.jpg">';
@@ -127,6 +131,11 @@ 
 }
 //$fixed_navbar = true;
 
+/**
+ * @param boolean $show_return
+ * @param boolean $show_date
+ * @param string $prefix
+ */
 function project_footer($show_return, $show_date, $prefix) {
     // If you include any links, prepend URL with $prefix
     //

html/inc/token.inc

Doc Comments +10 added lines

@@ -27,6 +27,10 @@ 
 define("TOKEN_DURATION_ONE_DAY", 86400);
 define("TOKEN_DURATION_ONE_WEEK", 604800);
 
+/**
+ * @param string $type
+ * @param integer $duration
+ */
 function create_token($userid, $type, $duration) {
     $token = random_string();
     $now = time();
@@ -39,6 +43,9 @@ 
     return $token;
 }
 
+/**
+ * @param string $type
+ */
 function delete_token($userid, $token, $type) {
     $token = BoincDb::escape_string($token);
     $type = BoincDb::escape_string($type);
@@ -46,6 +53,9 @@ 
     return $result;
 }
 
+/**
+ * @param string $type
+ */
 function is_valid_token($userid, $token, $type) {
     $boincToken = BoincToken::lookup_valid_token($userid, $token, $type);
     if ( $boincToken == null ) {