silverstripe / silverstripe-framework

model/Hierarchy.php

Doc Comments +2 added lines, -2 removed lines

@@ -379,7 +379,7 @@ 
 	/**
 	 * Return the IDs of all the marked nodes.
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public function markedNodeIDs() {
 		return array_keys($this->markedNodes);
@@ -756,7 +756,7 @@ 
 	 * Get the next node in the tree of the type. If there is no instance of the className descended from this node,
 	 * then search the parents.
 	 * @param string     $className Class name of the node to find.
-	 * @param string|int $root      ID/ClassName of the node to limit the search to
+	 * @param integer $root      ID/ClassName of the node to limit the search to
 	 * @param DataObject $afterNode Used for recursive calls to this function
 	 * @return DataObject
 	 */

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

api/RSSFeed.php

Doc Comments +3 added lines, -1 removed lines

@@ -191,7 +191,7 @@ 
 	 *
 	 * TODO: Pass $response object to ->outputToBrowser() to loosen dependence on global state for easier testing/prototyping so dev can inject custom SS_HTTPResponse instance.
 	 *
-	 * @return	HTMLText
+	 * @return	DBField
 	 */
 	public function outputToBrowser() {
 		$prevState = Config::inst()->get('SSViewer', 'source_file_comments');
@@ -222,6 +222,7 @@ 
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;
@@ -318,6 +319,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) {

forms/htmleditor/EmbedShortcodeProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 	/**
 	 * Gets the list of shortcodes provided by this handler
 	 *
-	 * @return mixed
+	 * @return string[]
 	 */
 	public static function get_shortcodes()
 	{

control/Controller.php

Doc Comments +4 added lines, -3 removed lines

@@ -132,6 +132,7 @@ 
 	 * {@inheritdoc}
 	 *
 	 * Also set the URLParams
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$return = parent::setRequest($request);
@@ -372,7 +373,7 @@ 
 	 *
 	 * @param string $action
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function defaultAction($action) {
 		return $this->getViewer($action)->process($this);
@@ -508,7 +509,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return DBField
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -673,7 +674,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

control/RequestHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -121,6 +121,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -271,7 +275,7 @@ 
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */
@@ -384,6 +388,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);

control/injector/Injector.php

Doc Comments +3 added lines, -5 removed lines

@@ -356,7 +356,7 @@ 
 	 *
 	 * @param string $property
 	 *				the name of the property
-	 * @param object $object
+	 * @param string $object
 	 *				the object to be set
 	 */
 	public function addAutoProperty($property, $object) {
@@ -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
@@ -755,6 +755,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)
 	 */
@@ -918,7 +919,6 @@ 
 	 * Additional parameters are passed through as
 	 *
 	 * @param string $name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return mixed A new instance of the specified object
 	 */
 	public function create($name) {
@@ -932,8 +932,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/ClassInfo.php

Doc Comments +6 added lines, -1 removed lines

@@ -43,6 +43,7 @@ 
 
 	/**
 	 * @todo Move this to SS_Database or DB
+	 * @param string $class
 	 */
 	public static function hasTable($class) {
 		// Cache the list of all table names to reduce on DB traffic
@@ -80,7 +81,7 @@ 
 	 *
 	 * @todo Move this into {@see DataObjectSchema}
 	 *
-	 * @param string|object $class
+	 * @param string $class
 	 * @return array
 	 */
 	public static function dataClassesFor($class) {
@@ -205,6 +206,7 @@ 
 
 	/**
 	 * Returns true if the given class implements the given interface
+	 * @param string $interfaceName
 	 */
 	public static function classImplements($className, $interfaceName) {
 		return in_array($className, self::implementorsOf($interfaceName));
@@ -255,6 +257,9 @@ 
 
 	private static $method_from_cache = array();
 
+	/**
+	 * @param string $method
+	 */
 	public static function has_method_from($class, $method, $compclass) {
 		$lClass = strtolower($class);
 		$lMethod = strtolower($method);

core/Convert.php

Doc Comments +3 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @param array|string $val String to escape, or array of strings
 	 *
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -176,7 +176,7 @@ 
 	 * table, or column name. Supports encoding of multi identfiers separated by
 	 * a delimiter (e.g. ".")
 	 *
-	 * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
+	 * @param string $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
 	 * to be joined via the separator.
 	 * @param string $separator The string that delimits subsequent identifiers
 	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
@@ -257,6 +257,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */