silverstripe / silverstripe-framework

thirdparty/Zend/Translate/Adapter/Xliff.php

Doc Comments +4 added lines, -1 removed lines

@@ -48,7 +48,7 @@ 
      * @param  string  $locale    Locale/Language to add data for, identical with locale identifier,
      *                            see Zend_Locale for more information
      * @param  string  $filename  XMLTM file to add, full path must be given for access
-     * @param  array   $option    OPTIONAL Options to use
+     * @param  array   $options    OPTIONAL Options to use
      * @throws Zend_Translation_Exception
      * @return array
      */
@@ -116,6 +116,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     private function _findEncoding($filename)
     {
         $file = file_get_contents($filename, null, null, 0, 100);

thirdparty/Zend/Cache/Backend/File.php

Doc Comments +4 added lines

@@ -732,6 +732,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $mode
+     */
     protected function _get($dir, $mode, $tags = array())
     {
         if (!is_dir($dir)) {
@@ -819,6 +822,7 @@ 
     /**
      * Compute & return the expire time
      *
+     * @param integer $lifetime
      * @return int expire time (unix timestamp)
      */
     protected function _expireTime($lifetime)

forms/DatetimeField.php

Doc Comments +19 added lines, -4 removed lines

@@ -59,6 +59,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -71,6 +75,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -81,6 +88,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -93,7 +103,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -108,7 +118,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -243,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -268,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -306,7 +318,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -324,7 +336,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -334,6 +346,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

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 DBField - the HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

forms/InlineFormAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
 
 	/**
 	 * Create a new action button.
-	 * @param action The method to call when the button is clicked
+	 * @param action string method to call when the button is clicked
 	 * @param title The label on the button
 	 * @param extraClass A CSS class to apply to the button in addition to 'action'
 	 */
@@ -32,7 +32,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		if($this->includeDefaultJS) {
@@ -78,7 +78,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',

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.