BOINC / boinc

drupal/sites/all/themes/zen/template.php

Doc Comments +5 added lines, -5 removed lines

@@ -32,7 +32,7 @@ 
  * @param $breadcrumb
  *   An array containing the breadcrumb links.
  * @return
- *   A string containing the breadcrumb output.
+ string   A string containing the breadcrumb output.
  */
 function zen_breadcrumb($breadcrumb) {
   // Determine if we are to display the breadcrumb.
@@ -87,7 +87,7 @@ 
  *   See http://juicystudio.com/article/screen-readers-display-none.php
  *   and http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
  * @return
- *   A string containing an unordered list of links.
+ string   A string containing an unordered list of links.
  */
 function zen_links($links, $attributes = array('class' => 'links'), $heading = '') {
   global $language;
@@ -600,10 +600,10 @@ 
    * Do not pass one string containing multiple classes as they will be
    * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
    *
-   * @param $class
+   * @param string $class
    *   The class name to clean.
    * @return
-   *   The cleaned class name.
+   string   The cleaned class name.
    */
   function drupal_html_class($class) {
     // By default, we filter using Drupal's coding standards.
@@ -633,7 +633,7 @@ 
    * @param $id
    *   The ID to clean.
    * @return
-   *   The cleaned ID.
+   string   The cleaned ID.
    */
   function drupal_html_id($id) {
     $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));

drupal/sites/default/boinc/modules/boincimport/boincimport.module

Doc Comments +2 added lines, -1 removed lines

@@ -132,7 +132,7 @@ 
  * Set database connection for boincimport
  *
  * @return
- *   1 if can connect to BOINC database.
+ integer   1 if can connect to BOINC database.
  *
  * BEWARE: if you test using db_connect and the connection
  * fails, the process will die() which is a bit too much since we only
@@ -162,6 +162,7 @@ 
 /**
  * Check if the module is enabled.
  * 
+ * @param string $module
  * @return array
  *    $out['html'] = formatted html.
  *    $out['result'] = boolean.

drupal/sites/default/boinc/modules/boincstats/boincstats.module

Doc Comments +3 added lines

@@ -422,6 +422,9 @@
 /*
  *
  */
+/**
+ * @param integer $credit
+ */
 function boincstats_credit_to_ghours($credit) {
   return $credit / (100 * 365);
 }

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pBarcode128.class.php

Doc Comments +4 added lines

@@ -179,6 +179,10 @@
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pBarcode39.class.php

Doc Comments +8 added lines

@@ -181,6 +181,9 @@ 
       }
     }
 
+   /**
+    * @param string $string
+    */
    function checksum( $string )
     {
      $checksum = 0;
@@ -195,6 +198,11 @@ 
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $Depart
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pCache.class.php

Doc Comments +11 added lines

@@ -47,6 +47,10 @@ 
     { return(md5($Marker.serialize($Data->Data))); }
 
    /* Write the generated picture to the cache */
+
+   /**
+    * @param pImage $pChartObject
+    */
    function writeToCache($ID,$pChartObject)
     {
      /* Compute the paths */
@@ -81,6 +85,10 @@ 
     }
 
    /* Remove object older than the specified TS */
+
+   /**
+    * @param integer $Expiry
+    */
    function removeOlderThan($Expiry)
     { $this->dbRemoval(array("Expiry"=>$Expiry)); }
 
@@ -235,6 +243,9 @@ 
      return(TRUE);
     }
 
+   /**
+    * @param string $Destination
+    */
    function saveFromCache($ID,$Destination)
     {
      /* Get the raw picture from the cache */

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pData.class.php

Doc Comments +25 added lines

@@ -105,6 +105,10 @@ 
     }
 
    /* Strip VOID values */
+
+   /**
+    * @param string $Values
+    */
    function stripVOID($Values)
     { if (!is_array($Values)) { return(array()); } $Result = array(); foreach($Values as $Key => $Value) { if ( $Value != VOID ) { $Result[] = $Value; } } return($Result); }
 
@@ -414,6 +418,11 @@ 
     }
 
    /* Set the position of an Axis */
+
+   /**
+    * @param integer $AxisID
+    * @param integer $Position
+    */
    function setAxisPosition($AxisID,$Position=AXIS_POSITION_LEFT)
     { if ( isset($this->Data["Axis"][$AxisID] ) ) { $this->Data["Axis"][$AxisID]["Position"] = $Position; } }
 
@@ -497,6 +506,10 @@ 
     }
 
    /* Set the color of one serie */
+
+   /**
+    * @param string $Series
+    */
    function setPalette($Series,$Format=NULL)
     {
      if ( !is_array($Series) ) { $Series = $this->convertToArray($Series); }
@@ -559,6 +572,10 @@ 
     }
 
    /* Initialise a given scatter serie */
+
+   /**
+    * @param integer $ID
+    */
    function initScatterSerie($ID)
     {
      if ( isset($this->Data["ScatterSeries"][$ID]) ) { return(0); }
@@ -581,6 +598,10 @@ 
     }
 
    /* Initialise a given serie */
+
+   /**
+    * @param string $Serie
+    */
    function initialise($Serie)
     {
      if ( isset($this->Data["Series"]) ) { $ID = count($this->Data["Series"]); } else { $ID = 0; }
@@ -781,6 +802,10 @@ 
     { return("pData object."); }
 
    function left($value,$NbChar)	{ return substr($value,0,$NbChar); }  
+
+   /**
+    * @param integer $NbChar
+    */
    function right($value,$NbChar)	{ return substr($value,strlen($value)-$NbChar,$NbChar); }  
    function mid($value,$Depart,$NbChar)	{ return substr($value,$Depart-1,$NbChar); }  
   }

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pDraw.class.php

Doc Comments +44 added lines

@@ -124,6 +124,10 @@ 
     }
 
    /* Draw a polygon */
+
+   /**
+    * @param string $Points
+    */
    function drawPolygon($Points,$Format="")
     {
      $R			= isset($Format["R"]) ? $Format["R"] : 0;
@@ -573,6 +577,10 @@ 
     }
 
    /* Drawn a spline based on the bezier function */
+
+   /**
+    * @param string $Coordinates
+    */
    function drawSpline($Coordinates,$Format="")
     {
      $R		= isset($Format["R"]) ? $Format["R"] : 0;
@@ -1028,6 +1036,10 @@ 
     }
 
    /* Draw a gradient within a defined area */
+
+   /**
+    * @param integer $Direction
+    */
    function drawGradientArea($X1,$Y1,$X2,$Y2,$Direction,$Format="")
     {
      $StartR	= isset($Format["StartR"]) ? $Format["StartR"] : 90;
@@ -1109,6 +1121,11 @@ 
     }
 
    /* Draw an aliased pixel */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    */
    function drawAntialiasPixel($X,$Y,$Format="")
     {
      $R     = isset($Format["R"]) ? $Format["R"] : 0;
@@ -1188,6 +1205,10 @@ 
     }
 
    /* Convert apha to base 10 */
+
+   /**
+    * @param integer $AlphaValue
+    */
    function convertAlpha($AlphaValue)
     { return((127/100)*(100-$AlphaValue)); }
 
@@ -1205,6 +1226,11 @@ 
     }
 
    /* Load a PNG file and draw it over the chart */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    */
    function drawFromPNG($X,$Y,$FileName)
     { $this->drawFromPicture(1,$FileName,$X,$Y); }
 
@@ -2483,6 +2509,9 @@ 
       }
     }
 
+   /**
+    * @param integer $ID
+    */
    function isValidLabel($Value,$LastValue,$LabelingMethod,$ID,$LabelSkip)
     {
      if ( $LabelingMethod == LABELING_DIFFERENT && $Value != $LastValue ) { return(TRUE); }
@@ -2494,6 +2523,10 @@ 
     }
 
    /* Compute the scale, check for the best visual factors */
+
+   /**
+    * @param double $MaxDivs
+    */
    function computeScale($XMin,$XMax,$MaxDivs,$Factors,$AxisID=0)
     {
      /* Compute each factors */
@@ -2522,6 +2555,10 @@ 
     }
 
    /* Compute the best matching scale based on size & factors */
+
+   /**
+    * @param integer $AxisID
+    */
    function processScale($XMin,$XMax,$MaxDivs,$Factors,$AxisID)
     {
      $ScaleHeight = abs(ceil($XMax)-floor($XMin));
@@ -2602,6 +2639,9 @@ 
      return($Scale);
     }
 
+   /**
+    * @param double $Value2
+    */
    function modulo($Value1,$Value2)
     {
      if (floor($Value2) == 0) { return(0); }
@@ -5772,6 +5812,10 @@ 
     }
 
    /* Draw a label box */
+
+   /**
+    * @param string $Captions
+    */
    function drawLabelBox($X,$Y,$Title,$Captions,$Format="")
     {
      $NoTitle		= isset($Format["NoTitle"]) ? $Format["NoTitle"] : NULL;

drupal/sites/default/boinc/modules/boincstats/includes/pchart/class/pImage.class.php

Doc Comments +17 added lines

@@ -82,6 +82,12 @@ 
    var $LastChartLayout	= CHART_LAST_LAYOUT_REGULAR;	// Last layout : regular or stacked
 
    /* Class constructor */
+
+   /**
+    * @param integer $XSize
+    * @param integer $YSize
+    * @param pData $DataSet
+    */
    function pImage($XSize,$YSize,$DataSet=NULL,$TransparentBackground=FALSE)
     {
      $this->TransparentBackground = $TransparentBackground;
@@ -126,6 +132,13 @@ 
     }
 
    /* Set the graph area position */
+
+   /**
+    * @param integer $X1
+    * @param integer $Y1
+    * @param integer $X2
+    * @param integer $Y2
+    */
    function setGraphArea($X1,$Y1,$X2,$Y2)
     {
      if ( $X2 < $X1 || $X1 == $X2 || $Y2 < $Y1 || $Y1 == $Y2 ) { return(-1); }
@@ -145,6 +158,10 @@ 
     { return($this->YSize); }
 
    /* Render the picture to a file */
+
+   /**
+    * @param string $FileName
+    */
    function render($FileName)
     {
      if ( $this->TransparentBackground ) { imagealphablending($this->Picture,false); imagesavealpha($this->Picture,true); }