BOINC / boinc

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

html/inc/forum.inc

Doc Comments +15 added lines

@@ -224,6 +224,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) {
@@ -504,6 +507,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, $start=0,
     $latest_viewed=0, $controls=FORUM_CONTROLS, $filter=true
@@ -879,6 +885,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) {
     global $forum_error;
     if (POST_MAX_LINKS
@@ -1133,6 +1142,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) {
@@ -1158,6 +1170,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
 ){