silverstripe / silverstripe-framework

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

core/Injectable.php

Doc Comments -2 removed lines

@@ -23,8 +23,6 @@
 	 *    $list = DataList::create('SiteTree');
 	 *	  $list = SiteTree::get();
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function create() {

view/Requirements.php

Doc Comments +3 added lines, -1 removed lines

@@ -65,6 +65,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()->setSuffixRequirements($var);
@@ -336,7 +337,7 @@ 
 	 * </code>
 	 *
 	 * @param string $combinedFileName Filename of the combined file relative to docroot
-	 * @param array  $files            Array of filenames relative to docroot
+	 * @param string[]  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
 	 * @return bool|void
@@ -761,6 +762,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 * @return $this
 	 */
 	public function setForceJSToBottom($var) {

admin/code/ModelAdmin.php

Doc Comments +3 added lines

@@ -117,6 +117,9 @@
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/ModelAdmin.js');
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
 		return parent::Link($action);

forms/htmleditor/HTMLEditorConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 	 * Get the current value of an option
      *
 	 * @param string $key The key of the option to get
-	 * @return mixed The value of the specified option
+	 * @return string The value of the specified option
 	 */
 	abstract public function getOption($key);
 

forms/HTMLEditorSanitiser.php

Doc Comments +2 added lines, -1 removed lines

@@ -39,7 +39,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -180,6 +180,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {

view/SSTemplateParser.php.inc

Doc Comments +9 added lines, -5 removed lines

@@ -111,6 +111,8 @@ 
 
 	/**
 	 * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+	 * @param string $matchrule
+	 * @param string $name
 	 */
 	function construct($matchrule, $name, $arguments = null) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -172,9 +174,9 @@ 
 
 	/**
 	 * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-	 * @param $name
-	 * @param $callable
-	 * @param $type
+	 * @param string $name
+	 * @param callable $callable
+	 * @param string $type
 	 * @throws InvalidArgumentException
 	 */
 	protected function validateExtensionBlock($name, $callable, $type) {
@@ -737,6 +739,7 @@ 
 	 * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
 	 * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
 	 * depending on the context the lookup is used in.
+	 * @param string $method
 	 */
 	function Lookup_AddLookupStep(&$res, $sub, $method) {
 		$res['LookupSteps'][] = $sub;
@@ -4691,8 +4694,8 @@ 
 	 * Compiles some passed template source code into the php code that will execute as per the template source.
 	 *
 	 * @throws SSTemplateParseException
-	 * @param  $string The source of the template
-	 * @param string $templateName The name of the template, normally the filename the template source was loaded from
+	 * @param  string $string The source of the template
+	 * @param string string The name of the template, normally the filename the template source was loaded from
 	 * @param bool $includeDebuggingComments True is debugging comments should be included in the output
 	 * @param bool $topTemplate True if this is a top template, false if it's just a template
 	 * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source
@@ -4732,6 +4735,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

core/startup/ErrorControlChain.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 	/**
 	 * Get value of display_errors ini value
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	protected function getDisplayErrors() {
 		return ini_get('display_errors');
@@ -110,7 +110,7 @@ 
 	 * Add this callback to the chain of callbacks to call along with the state
 	 * that $error must be in this point in the chain for the callback to be called
 	 *
-	 * @param $callback - The callback to call
+	 * @param callable $callback - The callback to call
 	 * @param $onErrorState - false if only call if no errors yet, true if only call if already errors, null for either
 	 * @return $this
 	 */

tests/core/startup/ErrorControlChainTest.php

Doc Comments +5 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	/**
 	 * Modify method visibility to public for testing
 	 *
-	 * @param mixed $errors
+	 * @param string $errors
 	 */
 	public function setDisplayErrors($errors)
 	{
@@ -33,6 +33,10 @@ 
 	}
 
 	// Change function visibility to be testable directly
+
+	/**
+	 * @param string $memstring
+	 */
 	public function translateMemstring($memstring) {
 		return parent::translateMemstring($memstring);
 	}