silverstripe / silverstripe-framework

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

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

forms/gridfield/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -76,7 +76,7 @@ 
 	 * @param DataObject $record
 	 * @param string $columnName
 	 *
-	 * @return string - the HTML for the column
+	 * @return DBHTMLText - the HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

tests/view/SSViewerTest.php

Doc Comments +13 added lines

@@ -123,6 +123,10 @@ 
 		));
 	}
 
+	/**
+	 * @param DBHTMLText $result
+	 * @param string[] $expected
+	 */
 	private function assertExpectedStrings($result, $expected) {
 		foreach ($expected as $expectedStr) {
 			$this->assertTrue(
@@ -756,6 +760,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));
 	}
@@ -1375,6 +1383,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 +13 added lines, -4 removed lines

@@ -368,7 +368,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
 	 */
@@ -442,6 +441,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) {
@@ -849,7 +852,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1254,7 +1257,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBHTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1280,6 +1283,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1308,7 +1314,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) {
@@ -1349,6 +1355,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

view/ViewableData.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;

dev/BulkLoader.php

Doc Comments +6 added lines, -6 removed lines

@@ -211,7 +211,7 @@ 
 	 *
 	 * @todo Mix in custom column mappings
 	 *
-	 * @return array
+	 * @return string
 	 **/
 	public function getImportSpec() {
 		$spec = array();
@@ -237,7 +237,7 @@ 
 	 * so this is mainly a customization method.
 	 *
 	 * @param mixed $val
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
 	 * @return boolean
 	 */
 	protected function isNullValue($val, $fieldName = null) {
@@ -361,7 +361,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addCreated($obj, $message = null) {
 		$this->created[] = $this->lastChange = array(
@@ -374,7 +374,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addUpdated($obj, $message = null) {
 		$this->updated[] = $this->lastChange = array(
@@ -386,8 +386,8 @@ 
 	}
 
 	/**
-	 * @param $obj DataObject
-	 * @param $message string
+	 * @param DataObject|null $obj DataObject
+	 * @param string $message string
 	 */
 	public function addDeleted($obj, $message = null) {
 		$data = $obj->toMap();

core/Convert.php

Doc Comments +4 added lines, -3 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
 	 */
@@ -450,7 +451,7 @@ 
 	 * - IDField => idField
 	 * - iDField => iDField
 	 *
-	 * @param $str
+	 * @param string $str
 	 * @return string
 	 */
 	public static function upperCamelToLowerCamel($str) {

filesystem/FileMigrationHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
 	/**
 	 * Get list of File dataobjects to import
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	protected function getFileQuery() {
 		// Select all records which have a Filename value, but not FileFilename.

filesystem/Folder.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
 	 * Find the given folder or create it as a database record
 	 *
 	 * @param string $folderPath Directory path relative to assets root
-	 * @return Folder|null
+	 * @return null|SilverStripe\ORM\DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes
@@ -149,7 +149,7 @@ 
 	/**
 	 * Returns all children of this folder
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function myChildren() {
 		return File::get()->filter("ParentID", $this->ID);
@@ -200,7 +200,7 @@ 
 	/**
 	 * Get the children of this folder that are also folders.
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function ChildFolders() {
 		return Folder::get()->filter('ParentID', $this->ID);