silverstripe / silverstripe-framework

control/injector/Injector.php

Doc Comments +2 added lines, -3 removed lines

@@ -450,7 +450,7 @@ 
 	 *				The name of the service to update the definition for
 	 * @param string $property
 	 *				The name of the property to update.
-	 * @param mixed $value
+	 * @param string $value
 	 *				The value to set
 	 * @param boolean $append
 	 *				Whether to append (the default) when the property is an array
@@ -718,6 +718,7 @@ 
 	 *
 	 * Will recursively call hasService for each depth of dotting
 	 *
+	 * @param string $name
 	 * @return string
 	 *				The name of the service (as it might be different from the one passed in)
 	 */
@@ -894,8 +895,6 @@ 
 	 *
 	 * @param string $name
 	 *				Name of the class to create an object of
-	 * @param array $args
-	 *				Arguments to pass to the constructor
 	 * @return mixed
 	 */
 	public function createWithArgs($name, $constructorArgs) {

core/Diff.php

Doc Comments +10 added lines, -1 removed lines

@@ -242,6 +242,10 @@ 
 	 * match.  The caller must trim matching lines from the beginning and end
 	 * of the portions it is going to specify.
 	 */
+
+	/**
+	 * @param double $nchunks
+	 */
 	public function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) {
 	$flip = false;
 
@@ -352,6 +356,11 @@ 
 	 * Note that XLIM, YLIM are exclusive bounds.
 	 * All line numbers are origin-0 and discarded lines are not counted.
 	 */
+
+	/**
+	 * @param integer $xoff
+	 * @param integer $yoff
+	 */
 	public function _compareseq ($xoff, $xlim, $yoff, $ylim) {
 	// Slide down the bottom initial diagonal.
 	while ($xoff < $xlim && $yoff < $ylim
@@ -549,7 +558,7 @@ 
 	 *
 	 *  $diff = new Diff($lines1, $lines2);
 	 *  $rev = $diff->reverse();
-	 * @return SS_Object A Diff object representing the inverse of the
+	 * @return Diff A Diff object representing the inverse of the
 	 *                original diff.
 	 */
 	public function reverse () {

core/Object.php

Doc Comments +8 added lines, -9 removed lines

@@ -125,8 +125,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() {
@@ -149,7 +147,6 @@ 
 	 * way to access instance methods which don't rely on instance
 	 * data (e.g. the custom SilverStripe static handling).
 	 *
-	 * @param string $className Optional classname (if called on Object directly)
 	 * @return static The singleton instance
 	 */
 	public static function singleton() {
@@ -334,8 +331,6 @@ 
 	 * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to
 	 * TRUE when using {@link Object::useCustomClass()}
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function strong_create() {
@@ -387,8 +382,8 @@ 
 	 * without any inheritance, merging or parent lookup if it doesn't exist on the given class.
 	 *
 	 * @static
-	 * @param $class - The class to get the static from
-	 * @param $name - The property to get from the class
+	 * @param string $class - The class to get the static from
+	 * @param string $name - The property to get from the class
 	 * @param null $default - The value to return if property doesn't exist on class
 	 * @return any - The value of the static property $name on class $class, or $default if that property is not
 	 *               defined
@@ -956,6 +951,7 @@ 
 
 	/**
 	 * @see SS_Object::get_static()
+	 * @param string $name
 	 */
 	public function stat($name, $uncached = false) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET);
@@ -963,6 +959,8 @@ 
 
 	/**
 	 * @see SS_Object::set_static()
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function set_stat($name, $value) {
 		Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value);
@@ -970,6 +968,7 @@ 
 
 	/**
 	 * @see SS_Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -1020,7 +1019,7 @@ 
 	 * all results into an array
 	 *
 	 * @param string $method the method name to call
-	 * @param mixed $argument a single argument to pass
+	 * @param string $argument a single argument to pass
 	 * @return mixed
 	 * @todo integrate inheritance rules
 	 */
@@ -1043,7 +1042,7 @@ 
 	 * The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
 	 *
 	 * @param string $method the name of the method to call on each extension
-	 * @param mixed $a1,... up to 7 arguments to be passed to the method
+	 * @param DataObject $a4
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {

dev/Backtrace.php

Doc Comments +2 added lines, -2 removed lines

@@ -115,7 +115,7 @@ 
 	 *
 	 * @param unknown_type $returnVal
 	 * @param unknown_type $ignoreAjax
-	 * @return unknown
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -132,7 +132,7 @@ 
 	 * shown
 	 *
 	 * @param SS_Object $item
-	 * @param boolean $showArg
+	 * @param boolean $showArgs
 	 * @param Int $argCharLimit
 	 * @return String
 	 */

filesystem/Upload.php

Doc Comments +4 added lines, -3 removed lines

@@ -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));

security/Security.php

Doc Comments +4 added lines, -5 removed lines

@@ -496,7 +496,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -676,7 +676,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken      = urldecode($autologinToken);
@@ -767,7 +766,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return SS_Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -951,7 +950,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1106,7 +1105,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

thirdparty/Zend/Loader/Autoloader.php

Doc Comments +6 added lines, -6 removed lines

@@ -138,7 +138,7 @@ 
      * Set the default autoloader implementation
      *
      * @param  string|array $callback PHP callback
-     * @return void
+     * @return Zend_Loader_Autoloader
      */
     public function setDefaultAutoloader($callback)
     {
@@ -371,8 +371,8 @@ 
     /**
      * Add an autoloader to the beginning of the stack
      *
-     * @param  SS_Object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
-     * @param  string|array $namespace Specific namespace(s) under which to register callback
+     * @param  Zend_Loader_Autoloader_Resource $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
+     * @param  string $namespace Specific namespace(s) under which to register callback
      * @return Zend_Loader_Autoloader
      */
     public function unshiftAutoloader($callback, $namespace = '')
@@ -394,7 +394,7 @@ 
     /**
      * Append an autoloader to the autoloader stack
      *
-     * @param  SS_Object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
+     * @param  string[] $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
      * @param  string|array $namespace Specific namespace(s) under which to register callback
      * @return Zend_Loader_Autoloader
      */
@@ -417,7 +417,7 @@ 
     /**
      * Remove an autoloader from the autoloader stack
      *
-     * @param  SS_Object|array|string $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
+     * @param  string[] $callback PHP callback or Zend_Loader_Autoloader_Interface implementation
      * @param  null|string|array $namespace Specific namespace(s) from which to remove autoloader
      * @return Zend_Loader_Autoloader
      */
@@ -467,7 +467,7 @@ 
      * Internal autoloader implementation
      *
      * @param  string $class
-     * @return bool
+     * @return string|false
      */
     protected function _autoload($class)
     {

thirdparty/Zend/Loader/Autoloader/Resource.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,7 +109,7 @@ 
      *
      * @param  string $method
      * @param  array $args
-     * @return mixed
+     * @return SS_Object
      * @throws Zend_Loader_Exception if method not beginning with 'get' or not matching a valid resource type is called
      */
     public function __call($method, $args)
@@ -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)
     {

view/SSViewer.php

Doc Comments +18 added lines, -5 removed lines

@@ -365,7 +365,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -415,6 +414,10 @@ 
 	 */
 	protected $underlay;
 
+	/**
+	 * @param SS_Object $item
+	 * @param SS_Object $inheritedScope
+	 */
 	public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null) {
 		parent::__construct($item, $inheritedScope);
 
@@ -439,6 +442,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -851,7 +858,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1254,9 +1261,9 @@ 
 	 * Used by the <% include %> template tag to process templates.
 	 *
 	 * @param string $template Template name
-	 * @param mixed $data Data context
+	 * @param SS_Object $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return HTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1282,6 +1289,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1310,7 +1320,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1351,6 +1361,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);