silverstripe / silverstripe-framework

tests/view/SSViewerTest.php

Doc Comments +13 added lines

@@ -112,6 +112,10 @@ 
 		));
 	}
 
+	/**
+	 * @param DBField $result
+	 * @param string[] $expected
+	 */
 	private function assertExpectedStrings($result, $expected) {
 		foreach ($expected as $expectedStr) {
 			$this->assertTrue(
@@ -718,6 +722,10 @@ 
 		$this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
 	}
 
+	/**
+	 * @param string $a
+	 * @param string $b
+	 */
 	public function assertEqualIgnoringWhitespace($a, $b) {
 		$this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b));
 	}
@@ -1328,6 +1336,11 @@ 
 		Config::inst()->update('SSViewer', 'source_file_comments', false);
 		Config::inst()->update('Director', 'environment_type', $origEnv);
 	}
+
+	/**
+	 * @param string $name
+	 * @param string $expected
+	 */
 	private function _renderWithSourceFileComments($name, $expected) {
 		$viewer = new SSViewer(array($name));
 		$data = new ArrayData(array());

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -338,7 +338,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
 	 */
@@ -412,6 +411,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) {
@@ -753,7 +756,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1083,7 +1086,7 @@ 
 	 * @param array|null $arguments - arguments to an included template
 	 * @param Object $inheritedScope - the current scope of a parent template including a sub-template
 	 *
-	 * @return HTMLText Parsed template output.
+	 * @return DBField Parsed template output.
 	 */
 	public function process($item, $arguments = null, $inheritedScope = null) {
 		SSViewer::$topLevel[] = $item;
@@ -1158,7 +1161,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBField Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1184,6 +1187,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1212,7 +1218,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) {
@@ -1253,6 +1259,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

@@ -37,6 +37,9 @@ 
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);
@@ -117,7 +120,7 @@ 
 	 * Render server configuration file from a template file
 	 *
 	 * @param string $template
-	 * @return \HTMLText Rendered results
+	 * @return string Rendered results
 	 */
 	protected function renderTemplate($template) {
 		// Build allowed extensions

filesystem/flysystem/ProtectedAssetAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      * Provide secure downloadable
      *
      * @param string $path
-     * @return string|null
+     * @return string
      */
     public function getProtectedUrl($path) {
         // Public URLs are handled via a request handler within /assets.

model/ValidationResult.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 	/**
 	 * Create a new ValidationResult.
 	 * By default, it is a successful result.	Call $this->error() to record errors.
+	 * @param string $message
 	 */
 	public function __construct($valid = true, $message = null) {
 		$this->isValid = $valid;

tests/filesystem/AssetStoreTest.php

Doc Comments +6 added lines

@@ -625,6 +625,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fileID
+	 */
 	public function getOriginalFilename($fileID) {
 		return parent::getOriginalFilename($fileID);
 	}
@@ -633,6 +636,9 @@ 
 		return parent::removeVariant($fileID);
 	}
 
+	/**
+	 * @param null|string $variant
+	 */
 	public function getDefaultConflictResolution($variant) {
 		return parent::getDefaultConflictResolution($variant);
 	}

model/connect/Database.php

Doc Comments +3 added lines, -2 removed lines

@@ -646,7 +646,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -681,7 +681,7 @@ 
 	/**
 	 * Returns the name of the currently selected database
 	 *
-	 * @return string|null Name of the selected database, or null if none selected
+	 * @return string Name of the selected database, or null if none selected
 	 */
 	public function getSelectedDatabase() {
 		return $this->connector->getSelectedDatabase();
@@ -806,6 +806,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

model/FieldType/DBClassName.php

Doc Comments +3 added lines

@@ -186,6 +186,9 @@
 		return $classNames;
 	}
 
+	/**
+	 * @param \DBClassNameTest_ObjectSubClass $record
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		parent::setValue($value, $record, $markChanged);
 

model/FieldType/DBComposite.php

Doc Comments +3 added lines

@@ -205,6 +205,9 @@
 		return null;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function hasField($field) {
 		$fields = $this->compositeDatabaseFields();
 		return isset($fields[$field]);