silverstripe / silverstripe-framework

model/fieldtypes/Int.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
 		return 0;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function prepValueForDB($value) {
 		if($value === true) {
 			return 1;

model/fieldtypes/Money.php

Doc Comments +6 added lines

@@ -236,6 +236,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getSymbol($currency = null, $locale = null) {
@@ -247,6 +249,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getShortName($currency = null, $locale = null) {
@@ -257,6 +261,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getName($currency = null, $locale = null) {

model/fieldtypes/PrimaryKey.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
 	/**
 	 * @param string $name
-	 * @param DataOject $object The object that this is primary key for (should have a relation with $name)
+	 * @param DataObject $object The object that this is primary key for (should have a relation with $name)
 	 */
 	public function __construct($name = null, $object) {
 		$this->object = $object;

model/Image_Backend.php

Doc Comments +2 added lines, -2 removed lines

@@ -71,8 +71,8 @@
 	/**
 	 * resizeRatio
 	 *
-	 * @param int $width
-	 * @param int $height
+	 * @param integer $maxWidth
+	 * @param integer $maxHeight
 	 * @return Image_Backend
 	 */
 	public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false);

model/queries/SQLQuery.php

Doc Comments +4 added lines

@@ -33,6 +33,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0
+	 * @param boolean $value
 	 */
 	public function setDelete($value) {
 		Deprecation::notice('4.0', 'SQLQuery::setDelete is deprecated. Use toDelete instead');
@@ -47,6 +48,9 @@ 
 		return $this->isDelete;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function sql(&$parameters = array()) {
 		return $this->toAppropriateExpression()->sql($parameters);
 	}

search/filters/SearchFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param boolean|string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName, $value = false, array $modifiers = array()) {
@@ -287,7 +287,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

tests/filesystem/UploadTest.php

Doc Comments +4 added lines

@@ -304,6 +304,10 @@
 	// Delete files in the default uploads directory that match the name pattern.
 	// @param String $namePattern	A regular expression applied to files in the directory. If the name matches
 	// the pattern, it is deleted. Directories, . and .. are excluded.
+
+	/**
+	 * @param string $namePattern
+	 */
 	public function deleteTestUploadFiles($namePattern) {
 		$tmpFolder = ASSETS_PATH . "/" . Config::inst()->get('Upload', 'uploads_folder');
 		$files = scandir($tmpFolder);

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;