silverstripe / silverstripe-framework

view/ViewableData.php

Doc Comments +6 added lines, -4 removed lines

@@ -144,7 +144,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -247,7 +247,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');
@@ -339,7 +339,7 @@ 
 	 *
 	 * @param string|array|SSViewer $template the template to render into
 	 * @param array $customFields fields to customise() the object with before rendering
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function renderWith($template, $customFields = null) {
 		if(!is_object($template)) {
@@ -499,6 +499,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));
@@ -506,6 +507,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));
@@ -513,6 +515,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));
@@ -523,7 +526,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) {

forms/FormField.php

Doc Comments +4 added lines, -3 removed lines

@@ -587,6 +587,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -698,7 +699,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1179,6 +1179,7 @@ 
 	 * @todo Make this abstract.
 	 *
 	 * @param Validator
+	 * @param RequiredFields $validator
 	 *
 	 * @return bool
 	 */
@@ -1248,7 +1249,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;
@@ -1433,7 +1434,7 @@ 
 	 * Any passed keys that are not defined in {@link getSchemaDataDefaults()} are ignored.
 	 * If you want to pass around ad hoc data use the `data` array e.g. pass `['data' => ['myCustomKey' => 'yolo']]`.
 	 *
-	 * @param array $schemaData - The data to be merged with $this->schemaData.
+	 * @param array $schemaState - The data to be merged with $this->schemaData.
 	 * @return FormField
 	 *
 	 * @todo Add deep merging of arrays like `data` and `attributes`.

admin/code/LeftAndMain.php

Doc Comments +8 added lines, -3 removed lines

@@ -182,7 +182,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -675,6 +675,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);
@@ -840,6 +841,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) {
@@ -1684,7 +1686,7 @@ 
 	 * The controller might not have any previewable content, in which case
 	 * this method returns FALSE.
 	 *
-	 * @return String|boolean
+	 * @return boolean
 	 */
 	public function LinkPreview() {
 		return false;
@@ -1868,7 +1870,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());
@@ -2034,6 +2036,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

model/versioning/ChangeSetItem.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	private function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);

model/versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1053,7 +1053,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1173,7 +1173,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param null|DataObject $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1283,7 +1283,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1358,7 +1358,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1428,7 +1428,7 @@ 
 	/**
 	 * Get the latest published DataObject.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2386,7 +2386,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

tests/model/ChangeSetTest.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
 		return $this->can(__FUNCTION__, $member, $context);
 	}
 
+	/**
+	 * @param string $perm
+	 */
 	public function can($perm, $member = null, $context = array()) {
 		$perms = [
 			"PERM_{$perm}",

thirdparty/tinymce/tiny_mce_gzip.php

Doc Comments +1 added lines, -2 removed lines

@@ -83,7 +83,6 @@ 
 	/**
 	 * Adds a file to the concatenation/compression process.
 	 *
-	 * @param String $path Path to the file to include in the compressed package/output.
 	 */
 	public function &addFile($file) {
 		$this->files .= ($this->files ? "," : "") . $file;
@@ -256,7 +255,7 @@ 
 	/**
 	 * Renders a script tag that loads the TinyMCE script.
 	 *
-	 * @param Array $settings Name/value array with settings for the script tag.
+	 * @param Array $tagSettings Name/value array with settings for the script tag.
 	 * @param Bool  $return   The script tag is return instead of being output if true
 	 * @return String the tag is returned if $return is true
 	 */

dev/SapphireTest.php

Doc Comments +9 added lines, -8 removed lines

@@ -139,6 +139,7 @@ 
 
 	/**
 	 * Set the manifest to be used to look up test classes by helper functions
+	 * @param SS_ClassManifest $manifest
 	 */
 	public static function set_test_class_manifest($manifest) {
 		self::$test_class_manifest = $manifest;
@@ -422,7 +423,7 @@ 
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
 	 *
 	 * @param string $className
-	 * @return array A map of fixture-identifier => object-id
+	 * @return A A map of fixture-identifier => object-id
 	 */
 	protected function allFixtureIDs($className) {
 		return $this->getFixtureFactory()->getIds($className);
@@ -582,10 +583,10 @@ 
 	/**
 	 * Assert that the matching email was sent since the last call to clearEmails()
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-	 * @param $to
+	 * @param string $to
 	 * @param $from
-	 * @param $subject
-	 * @param $content
+	 * @param string $subject
+	 * @param string $content
 	 * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
 	 *               'customHeaders', 'htmlContent', inlineImages'
 	 */
@@ -753,7 +754,7 @@ 
 	 * @param string $expectedSQL
 	 * @param string $actualSQL
 	 * @param string $message
-	 * @param float $delta
+	 * @param integer $delta
 	 * @param integer $maxDepth
 	 * @param boolean $canonicalize
 	 * @param boolean $ignoreCase
@@ -1039,9 +1040,9 @@ 
 	/**
 	 * Test against a theme.
 	 *
-	 * @param $themeBaseDir string - themes directory
-	 * @param $theme string - theme name
-	 * @param $callback Closure
+	 * @param string $themeBaseDir string - themes directory
+	 * @param string $theme string - theme name
+	 * @param Closure $callback Closure
 	 */
 	protected function useTestTheme($themeBaseDir, $theme, $callback) {
 		Config::nest();

email/Email.php

Doc Comments +22 added lines, -2 removed lines

@@ -150,6 +150,12 @@ 
 
 	/**
 	 * Create a new email.
+	 * @param string $from
+	 * @param string $to
+	 * @param string $subject
+	 * @param string $body
+	 * @param string $cc
+	 * @param string $bcc
 	 */
 	public function __construct($from = null, $to = null, $subject = null, $body = null, $bounceHandlerURL = null,
 			$cc = null, $bcc = null) {
@@ -168,6 +174,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $data
+	 */
 	public function attachFileFromString($data, $filename, $mimetype = null) {
 		$this->attachments[] = array(
 			'contents' => $data,
@@ -184,6 +193,10 @@ 
 		Deprecation::notice('4.0', 'Use "emailbouncehandler" module');
 	}
 
+	/**
+	 * @param string $filename
+	 * @param string $mimetype
+	 */
 	public function attachFile($filename, $attachedFilename = null, $mimetype = null) {
 		if(!$attachedFilename) $attachedFilename = basename($filename);
 		$absoluteFileName = Director::getAbsFile($filename);
@@ -219,6 +232,9 @@ 
 		return $this->bcc;
 	}
 
+	/**
+	 * @param string $val
+	 */
 	public function setSubject($val) {
 		$this->subject = $val;
 		return $this;
@@ -311,6 +327,9 @@ 
 		return $this->ss_template;
 	}
 
+	/**
+	 * @return ViewableData
+	 */
 	protected function templateData() {
 		if($this->template_data) {
 			return $this->template_data->customise(array(
@@ -390,6 +409,7 @@ 
 
 	/**
 	 * Validates the email address. Returns true of false
+	 * @param string $address
 	 */
 	public static function validEmailAddress($address) {
 		if (function_exists('filter_var')) {
@@ -611,8 +631,8 @@ 
 	/**
 	 * Checks for RFC822-valid email format.
 	 *
-	 * @param string $str
-	 * @return boolean
+	 * @param string $email
+	 * @return integer
 	 *
 	 * @copyright Cal Henderson <cal@iamcal.com>
 	 * 	This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License