silverstripe / silverstripe-framework

dev/BulkLoader.php

Doc Comments +6 added lines, -6 removed lines

@@ -211,7 +211,7 @@ 
 	 *
 	 * @todo Mix in custom column mappings
 	 *
-	 * @return array
+	 * @return string
 	 **/
 	public function getImportSpec() {
 		$spec = array();
@@ -237,7 +237,7 @@ 
 	 * so this is mainly a customization method.
 	 *
 	 * @param mixed $val
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
 	 * @return boolean
 	 */
 	protected function isNullValue($val, $fieldName = null) {
@@ -361,7 +361,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addCreated($obj, $message = null) {
 		$this->created[] = $this->lastChange = array(
@@ -374,7 +374,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addUpdated($obj, $message = null) {
 		$this->updated[] = $this->lastChange = array(
@@ -386,8 +386,8 @@ 
 	}
 
 	/**
-	 * @param $obj DataObject
-	 * @param $message string
+	 * @param DataObject|null $obj DataObject
+	 * @param string $message string
 	 */
 	public function addDeleted($obj, $message = null) {
 		$data = $obj->toMap();

control/HTTPRequest.php

Doc Comments +3 added lines, -3 removed lines

@@ -385,9 +385,9 @@ 
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
+	 * @param string $mimeType
 	 * @return SS_HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {
@@ -605,7 +605,7 @@ 
 	 * This is used by the request handler to prevent infinite parsing loops.
 	 *
 	 * @param $pattern
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function isEmptyPattern($pattern) {
 		if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {

thirdparty/Zend/Cache/Backend/BlackHole.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
      * Test if a cache is available or not (for the given id)
      *
      * @param  string $id cache id
-     * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
+     * @return boolean false (a cache is not available) or "last modified" timestamp (int) of the available cache record
      */
     public function test($id)
     {
@@ -192,7 +192,7 @@ 
      * - mtime : timestamp of last modification time
      *
      * @param  string $id cache id
-     * @return array array of metadatas (false if the cache id is not found)
+     * @return boolean array of metadatas (false if the cache id is not found)
      */
     public function getMetadatas($id)
     {

thirdparty/Zend/Loader/Autoloader/Resource.php

Doc Comments +1 added lines, -1 removed lines

@@ -136,7 +136,7 @@
      * Helper method to calculate the correct class path
      *
      * @param string $class
-     * @return False if not matched other wise the correct path
+     * @return false|string if not matched other wise the correct path
      */
     public function getClassPath($class)
     {

thirdparty/Zend/Loader/PluginLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -283,7 +283,7 @@
      * Whether or not a Plugin by a specific name is loaded
      *
      * @param string $name
-     * @return Zend_Loader_PluginLoader
+     * @return boolean
      */
     public function isLoaded($name)
     {

admin/code/LeftAndMain.php

Doc Comments +6 added lines, -1 removed lines

@@ -555,6 +555,7 @@ 
 	 * Returns the menu title for the given LeftAndMain subclass.
 	 * Implemented static so that we can get this value without instantiating an object.
 	 * Menu title is *not* internationalised.
+	 * @return string
 	 */
 	public static function menu_title_for_class($class) {
 		$title = Config::inst()->get($class, 'menu_title', Config::FIRST_SET);
@@ -720,6 +721,7 @@ 
 	 * Return a list of appropriate templates for this class, with the given suffix using
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
+	 * @param string $suffix
 	 * @return array
 	 */
 	public function getTemplatesWithSuffix($suffix) {
@@ -1740,7 +1742,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('DBLocale', i18n::get_locale());
@@ -1906,6 +1908,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

api/RSSFeed.php

Doc Comments +2 added lines

@@ -219,6 +219,7 @@ 
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;
@@ -315,6 +316,7 @@ 
 	/**
 	 * Return the named field as an obj() call from $this->failover.
 	 * Default to the given class if there's no casting information.
+	 * @param string $fieldName
 	 */
 	public function rssField($fieldName, $defaultClass = 'Varchar') {
 		if($fieldName) {

dev/DebugView.php

Doc Comments +1 added lines

@@ -126,6 +126,7 @@
 	 *
 	 * @param string $title
 	 * @param string $title
+	 * @param string|false $subtitle
 	 */
 	public function writeInfo($title, $subtitle, $description=false) {
 		echo '<div class="info">';

filesystem/Upload.php

Doc Comments +5 added lines, -4 removed lines

@@ -102,7 +102,7 @@ 
 	 * Set a different instance than {@link Upload_Validator}
 	 * for this upload session.
 	 *
-	 * @param object $validator
+	 * @param Upload_Validator $validator
 	 */
 	public function setValidator($validator) {
 		$this->validator = $validator;
@@ -223,7 +223,7 @@ 
 	 *
 	 * @param array $tmpFile
 	 * @param File $file
-	 * @return Boolean
+	 * @return boolean|string
 	 */
 	public function loadIntoFile($tmpFile, $file, $folderPath = false) {
 		$this->file = $file;
@@ -231,7 +231,8 @@ 
 	}
 
 	/**
-	 * @return Boolean
+	 * @param boolean $bool
+	 * @return boolean|null
 	 */
 	public function setReplaceFile($bool) {
 		$this->replaceFile = $bool;
@@ -295,7 +296,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));