silverstripe / silverstripe-framework

tests/forms/RequirementsTest.php

Doc Comments +14 added lines

@@ -51,6 +51,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedRequirements($backend) {
 		$basePath = $this->getCurrentRelativePath();
 
@@ -76,6 +79,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedNonrequiredRequirements($backend) {
 			$basePath = $this->getCurrentRelativePath();
 
@@ -452,6 +458,10 @@ 
 		$this->assertNotRegexp('/RequirementsTest_b\.css\?m=[\d]*&foo=bar&bla=blubb"/', $html);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch (strtolower($type)) {
@@ -496,6 +506,10 @@ 
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch ($type) {

thirdparty/spyc/spyc.php

Doc Comments +70 added lines

@@ -376,11 +376,17 @@ 
 
 // LOADING FUNCTIONS
 
+  /**
+   * @param string $input
+   */
   private function __load($input) {
     $Source = $this->loadFromSource($input);
     return $this->loadWithSource($Source);
   }
 
+  /**
+   * @param string $input
+   */
   private function __loadString($input) {
     $Source = $this->loadFromString($input);
     return $this->loadWithSource($Source);
@@ -598,6 +604,7 @@ 
   /**
      * Used in inlines to check for more inlines or quoted strings
      * @access private
+     * @param string $inline
      * @return array
      */
   private function _inlineEscape($inline) {
@@ -701,12 +708,18 @@ 
     return $explode;
   }
 
+  /**
+   * @param integer $lineIndent
+   */
   private function literalBlockContinues ($line, $lineIndent) {
     if (!trim($line)) return true;
     if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true;
     return false;
   }
 
+  /**
+   * @param boolean $alias
+   */
   private function referenceContentsByAlias ($alias) {
     do {
       if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; }
@@ -799,6 +812,9 @@ 
 
   }
 
+  /**
+   * @param string $line
+   */
   private static function startsLiteralBlock ($line) {
     $lastChar = substr (trim($line), -1);
     if ($lastChar != '>' && $lastChar != '|') return false;
@@ -808,6 +824,9 @@ 
     return $lastChar;
   }
 
+  /**
+   * @param string $line
+   */
   private static function greedilyNeedNextLine($line) {
     $line = trim ($line);
     if (!strlen($line)) return false;
@@ -817,6 +836,10 @@ 
     return false;
   }
 
+  /**
+   * @param string $literalBlock
+   * @param string $literalBlockStyle
+   */
   private function addLiteralLine ($literalBlock, $line, $literalBlockStyle) {
     $line = self::stripIndent($line);
     $line = rtrim ($line, "\r\n\t ") . "\n";
@@ -833,6 +856,9 @@ 
     return $literalBlock . $line;
   }
 
+   /**
+    * @param string $literalBlock
+    */
    function revertLiteralPlaceHolder ($lineArray, $literalBlock) {
      foreach ($lineArray as $k => $_) {
       if (is_array($_))
@@ -848,6 +874,9 @@ 
     return substr ($line, $indent);
   }
 
+  /**
+   * @param integer $indent
+   */
   private function getParentPathByIndent ($indent) {
     if ($indent == 0) return array();
     $linePath = $this->path;
@@ -873,6 +902,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private static function isComment ($line) {
     if (!$line) return false;
     if ($line[0] == '#') return true;
@@ -880,6 +912,9 @@ 
     return false;
   }
 
+  /**
+   * @param string $line
+   */
   private static function isEmpty ($line) {
     return (trim ($line) === '');
   }
@@ -905,10 +940,16 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private function startsMappedSequence ($line) {
     return ($line[0] == '-' && substr ($line, -1, 1) == ':');
   }
 
+  /**
+   * @param string $line
+   */
   private function returnMappedSequence ($line) {
     $array = array();
     $key         = trim(substr($line,1,-1));
@@ -917,6 +958,9 @@ 
     return array($array);
   }
 
+  /**
+   * @param string $line
+   */
   private function returnMappedValue ($line) {
     $array = array();
     $key         = trim(substr($line,0,-1));
@@ -924,18 +968,30 @@ 
     return $array;
   }
 
+  /**
+   * @param string $line
+   */
   private function startsMappedValue ($line) {
     return (substr ($line, -1, 1) == ':');
   }
   
+  /**
+   * @param string $line
+   */
   private function isPlainArray ($line) {
     return ($line[0] == '[' && substr ($line, -1, 1) == ']');
   }
   
+  /**
+   * @param string $line
+   */
   private function returnPlainArray ($line) {
     return $this->_toType($line); 
   }  
 
+  /**
+   * @param string $line
+   */
   private function returnKeyValuePair ($line) {
     $array = array();
     if (strpos ($line, ':')) {
@@ -965,6 +1021,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private function returnArrayElement ($line) {
      if (strlen($line) <= 1) return array(array()); // Weird %)
      $array = array();
@@ -975,6 +1034,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private function nodeContainsGroup ($line) {    
     $symbolsForReference = 'A-z0-9_\-';
     if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-)
@@ -987,12 +1049,20 @@ 
 
   }
 
+  /**
+   * @param string $line
+   * @param string $group
+   */
   private function addGroup ($line, $group) {
     if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1);
     if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1);
     //print_r ($this->path);
   }
 
+  /**
+   * @param string $line
+   * @param string $group
+   */
   private function stripGroup ($line, $group) {
     $line = trim(str_replace($group, '', $line));
     return $line;

thirdparty/tinymce-spellchecker/classes/GoogleSpell.php

Doc Comments +7 added lines

@@ -105,6 +105,9 @@ 
 		return $matches;

 	}

 

+	/**
+	 * @param string $string
+	 */
 	function _unhtmlentities($string) {

 		$string = preg_replace('~&#x([0-9a-f]+);~ei', 'chr(hexdec("\\1"))', $string);

 		$string = preg_replace('~&#([0-9]+);~e', 'chr(\\1)', $string);

@@ -118,6 +121,10 @@ 
 

 // Patch in multibyte support

 if (!function_exists('mb_substr')) {

+
+	/**
+	 * @param string $str
+	 */
 	function mb_substr($str, $start, $len = '', $encoding="UTF-8"){

 		$limit = strlen($str);

 

thirdparty/tinymce-spellchecker/classes/PSpell.php

Doc Comments +1 added lines

@@ -45,6 +45,7 @@
 

 	/**

 	 * Opens a link for pspell.

+	 * @return string
 	 */

 	function &_getPLink($lang) {

 		// Check for native PSpell support

thirdparty/Zend/Log.php

Doc Comments +1 added lines, -2 removed lines

@@ -160,7 +160,6 @@ 
     /**
      * Construct a writer object based on a configuration array
      *
-     * @param  array $spec config array with writer spec
      * @return Zend_Log_Writer_Abstract
      * @throws Zend_Log_Exception
      */
@@ -457,7 +456,7 @@ 
      * Before a message will be received by any of the writers, it
      * must be accepted by all filters added with this method.
      *
-     * @param  int|Zend_Config|array|Zend_Log_Filter_Interface $filter
+     * @param  Zend_Log_Filter_Priority $filter
      * @return Zend_Log
      * @throws Zend_Log_Exception
      */

thirdparty/Zend/Log/Writer/Stream.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
      *
      * @param array|string|resource $streamOrUrl Stream or URL to open as a stream
      * @param string|null $mode Mode, only applicable if a URL is given
-     * @return void
+     * @return null|Zend_Log_Writer_Abstract
      * @throws Zend_Log_Exception
      */
     public function __construct($streamOrUrl, $mode = null)

view/Requirements.php

Doc Comments +6 added lines, -4 removed lines

@@ -49,6 +49,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->set_suffix_requirements($var);
@@ -109,7 +110,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_custom_scripts() {
 		return self::backend()->get_custom_scripts();
@@ -517,7 +518,7 @@ 
 	/**
 	 * Enable or disable the combination of CSS and JavaScript files
 	 * 
-	 * @param $enable
+	 * @param boolean $enable
 	 */
 	public function set_combined_files_enabled($enable) {
 		$this->combined_files_enabled = (bool) $enable;
@@ -585,6 +586,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public function set_force_js_to_bottom($var) {
 		$this->force_js_to_bottom = $var;
@@ -624,7 +626,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function get_custom_scripts() {
 		$requirements = "";
@@ -1037,7 +1039,7 @@ 
 	 * @param array  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 * 
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function combine_files($combinedFileName, $files, $media = null) {
 		// duplicate check

view/ViewableData.php

Doc Comments +4 added lines, -2 removed lines

@@ -233,7 +233,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -485,6 +485,7 @@ 
 	
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -492,6 +493,7 @@ 
 	
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -499,6 +501,7 @@ 
 	
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -509,7 +512,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {

api/RestfulService.php

Doc Comments +5 added lines, -4 removed lines

@@ -334,8 +334,8 @@ 
 	/**
 	 * Extracts the response body and headers from a full curl response
 	 *
-	 * @param curl_handle $ch The curl handle for the request
-	 * @param string $rawResponse The raw response text
+	 * @param resource $ch The curl handle for the request
+	 * @param string $rawHeaders
 	 *
 	 * @return RestfulService_Response The response object
 	 */
@@ -391,7 +391,8 @@ 
 
 	/** 
 	 * Returns a full request url
-	 * @param string 
+	 * @param string
+	 * @param string $subURL 
 	 */ 
 	public function getAbsoluteRequestURL($subURL) {
 		$url = $this->baseURL . $subURL; // Url for the request
@@ -631,7 +632,7 @@ 
 	 * get the cached response object. This allows you to access the cached
 	 * eaders, not just the cached body.
 	 *
-	 * @return RestfulSerivice_Response The cached response object
+	 * @return boolean The cached response object
 	 */
 	public function getCachedResponse() {
 		return $this->cachedResponse;