silverstripe / silverstripe-framework

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
@@ -958,6 +953,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);
@@ -965,6 +961,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);
@@ -972,6 +970,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);
@@ -1022,7 +1021,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
 	 */
@@ -1048,7 +1047,7 @@ 
 	 * @param mixed $a1
 	 * @param mixed $a2
 	 * @param mixed $a3
-	 * @param mixed $a4
+	 * @param DataObject $a4
 	 * @param mixed $a5
 	 * @param mixed $a6
 	 * @param mixed $a7

security/CMSSecurity.php

Doc Comments +9 added lines

@@ -42,6 +42,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		$link = Controller::join_links(Director::baseURL(), "CMSSecurity", $action);
 		// Give extensions the chance to modify by reference
@@ -60,6 +63,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function getResponseController($title) {
 		// Use $this to prevent use of Page to render underlying templates
 		return $this;
@@ -175,6 +181,9 @@ 
 		user_error('Passed invalid authentication method', E_USER_ERROR);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function getTemplatesFor($action) {
 		return array("CMSSecurity_{$action}", "CMSSecurity")
 			+ parent::getTemplatesFor($action);

control/RequestHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -129,6 +129,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -246,6 +247,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -392,6 +396,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);
@@ -500,6 +505,7 @@ 
 	 * or {@link handleRequest()}, but in some based we want to set it manually.
 	 *
 	 * @param SS_HTTPRequest
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$this->request = $request;
@@ -508,7 +514,6 @@ 
 	/**
 	 * Returns a link to this controller.  Overload with your own Link rules if they exist.
 	 *
-	 * @param string $action Optional action (soft-supported via func_get_args)
 	 * @return string
 	 */
 	public function Link() {

dev/SapphireTest.php

Doc Comments +10 added lines, -9 removed lines

@@ -142,6 +142,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;
@@ -399,7 +400,7 @@ 
 	/**
 	 * Get the ID of an object from the fixture.
 	 *
-	 * @param $className The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $className The data class, as specified in your fixture file.  Parent classes won't work
 	 * @param $identifier The identifier string, as provided in your fixture file
 	 * @return int
 	 */
@@ -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);
@@ -580,10 +581,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'
 	 */
@@ -744,7 +745,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
@@ -982,9 +983,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();

control/HTTP.php

Doc Comments +12 added lines, -2 removed lines

@@ -99,7 +99,7 @@ 
 	 * @param string|callable $code Either a string that can evaluate to an expression
 	 * to rewrite links (depreciated), or a callable that takes a single
 	 * parameter and returns the rewritten URL
-	 * @return The content with all links rewritten as per the logic specified in $code
+	 * @return string content with all links rewritten as per the logic specified in $code
 	 */
 	public static function urlRewriter($content, $code) {
 		if(!is_callable($code)) {
@@ -243,6 +243,9 @@ 
 		return count($result) ? $result : null;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public static function getLinksIn($content) {
 		return self::findByTagAndAttribute($content, array("a" => "href"));
 	}
@@ -285,6 +288,7 @@ 
 
 	/**
 	 * Set the maximum age of this page in web caches, in seconds
+	 * @param integer $age
 	 */
 	public static function set_cache_age($age) {
 		self::$cache_age = $age;
@@ -297,11 +301,17 @@ 
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 */
 	public static function register_modification_timestamp($timestamp) {
 		if($timestamp > self::$modification_date)
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param string $etag
+	 */
 	public static function register_etag($etag) {
 		if (0 !== strpos($etag, '"')) {
 			$etag = sprintf('"%s"', $etag);
@@ -473,7 +483,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPResponse|string $response
+	 * @param null|SS_HTTPResponse $response
 	 *
 	 * @return string|false
 	 */