silverstripe / silverstripe-framework

view/ArrayData.php

Doc Comments +4 added lines, -10 removed lines

@@ -50,14 +50,7 @@ 
 	/**
 	 * Gets a field from this object.
 	 *
-	 * @param string $field
-	 *
-	 * If the value is an object but not an instance of
-	 * ViewableData, it will be converted recursively to an
-	 * ArrayData.
-	 *
-	 * If the value is an associative array, it will likewise be
-	 * converted recursively to an ArrayData.
+	 * @param string $f
 	 */
 	public function getField($f) {
 		$value = $this->array[$f];
@@ -73,7 +66,7 @@ 
 	* Add or set a field on this object.
 	*
 	* @param string $field
-	* @param mixed $value
+	* @param string $value
 	*/
 	public function setField($field, $value) {
 		$this->array[$field] = $value;
@@ -83,6 +76,7 @@ 
 	 * Check array to see if field isset
 	 *
 	 * @param string Field Key
+	 * @param string $f
 	 * @return bool
 	 */
 	public function hasField($f) {
@@ -93,7 +87,7 @@ 
 	 * Converts an associative array to a simple object
 	 *
 	 * @param array
-	 * @return obj $obj
+	 * @return stdClass $obj
 	 */
 	public static function array_to_object($arr = null) {
 		$obj = new stdClass();

view/SSTemplateParser.php

Doc Comments +9 added lines, -5 removed lines

@@ -111,6 +111,8 @@ 
 
 	/**
 	 * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+	 * @param string $matchrule
+	 * @param string $name
 	 */
 	function construct($matchrule, $name, $arguments = null) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -172,9 +174,9 @@ 
 
 	/**
 	 * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-	 * @param $name
-	 * @param $callable
-	 * @param $type
+	 * @param string $name
+	 * @param callable $callable
+	 * @param string $type
 	 * @throws InvalidArgumentException
 	 */
 	protected function validateExtensionBlock($name, $callable, $type) {
@@ -737,6 +739,7 @@ 
 	 * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
 	 * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
 	 * depending on the context the lookup is used in.
+	 * @param string $method
 	 */
 	function Lookup_AddLookupStep(&$res, $sub, $method) {
 		$res['LookupSteps'][] = $sub;
@@ -4691,8 +4694,8 @@ 
 	 * Compiles some passed template source code into the php code that will execute as per the template source.
 	 *
 	 * @throws SSTemplateParseException
-	 * @param  $string The source of the template
-	 * @param string $templateName The name of the template, normally the filename the template source was loaded from
+	 * @param  string $string The source of the template
+	 * @param string string The name of the template, normally the filename the template source was loaded from
 	 * @param bool $includeDebuggingComments True is debugging comments should be included in the output
 	 * @param bool $topTemplate True if this is a top template, false if it's just a template
 	 * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source
@@ -4732,6 +4735,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

dev/SilverStripeListener.php

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
 
 	protected $whitelist = false;
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $options = array()) {
 		if(is_string($options)) {
 			$options = array('whitelist' => $options);

thirdparty/jstree/_demo/_inc/class._database.php

Doc Comments +3 added lines

@@ -97,6 +97,9 @@
 		return $return;
 	}
 
+	/**
+	 * @param boolean $index
+	 */
 	function f($index) {
 		return stripslashes($this->row[$index]);
 	}

thirdparty/Zend/Translate/Adapter/Qt.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/Translate/Adapter/Tbx.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/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);

admin/code/CMSForm.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;

control/Director.php

Doc Comments +2 added lines, -3 removed lines

@@ -463,7 +463,7 @@ 
 	/**
 	 * Returns the part of the URL, 'http://www.mysite.com'.
 	 *
-	 * @return boolean|string The domain from the PHP environment. Returns FALSE is this environment variable isn't
+	 * @return string|false The domain from the PHP environment. Returns FALSE is this environment variable isn't
 	 *                        set.
 	 */
 	public static function protocolAndHost() {
@@ -747,7 +747,6 @@ 
 	/**
 	 * Takes a $_SERVER data array and extracts HTTP request headers.
 	 *
-	 * @param  array $data
 	 * @return array
 	 */
 	public static function extract_request_headers(array $server) {
@@ -780,7 +779,7 @@ 
 
 	/**
 	 * Returns true if the given file exists.
-	 * @param $file Filename specified relative to the site root
+	 * @param string $file Filename specified relative to the site root
 	 */
 	public static function fileExists($file) {
 		// replace any appended query-strings, e.g. /path/to/foo.php?bar=1 to /path/to/foo.php