silverstripe / silverstripe-framework

thirdparty/Zend/Translate/Adapter/Xliff.php

Doc Comments +4 added lines, -1 removed lines

@@ -54,7 +54,7 @@ 
      * @param  string  $locale    Locale/Language to add data for, identical with locale identifier,
      *                            see Zend_Locale for more information
      * @param  string  $filename  XLIFF 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
      */
@@ -206,6 +206,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     private function _findEncoding($filename)
     {
         $file = file_get_contents($filename, null, null, 0, 100);

thirdparty/Zend/Translate/Adapter/XmlTm.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_railsyaml/library/Translate/Adapter/RailsYAML.php

Doc Comments +2 added lines, -2 removed lines

@@ -17,7 +17,7 @@ 
     /**
      * Generates the adapter
      *
-     * @param  array|Zend_Config $options Translation content
+     * @param  string $options Translation content
      */
     public function __construct($options = array()) {
         $this->_options['keyDelimiter'] = ".";
@@ -31,7 +31,7 @@ 
      * @param  string|array  $data  Filename and full path to the translation source
      * @param  string        $locale    Locale/Language to add data for, identical with locale identifier,
      *                                  see Zend_Locale for more information
-     * @param  array         $option    OPTIONAL Options to use
+     * @param  array         $options    OPTIONAL Options to use
      */
     protected function _loadTranslationData($data, $locale, array $options = array())
     {   

thirdparty/zend_translate_railsyaml/library/Translate/Adapter/thirdparty/sfYaml/lib/sfYamlInline.php

Doc Comments +2 added lines, -2 removed lines

@@ -159,9 +159,9 @@
   /**
    * Parses a scalar to a YAML string.
    *
-   * @param scalar  $scalar
+   * @param string  $scalar
    * @param string  $delimiters
-   * @param array   $stringDelimiter
+   * @param array   $stringDelimiters
    * @param integer $i
    * @param boolean $evaluate
    *

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) {

view/SSViewer.php

Doc Comments +13 added lines, -4 removed lines

@@ -336,7 +336,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
 	 */
@@ -410,6 +409,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) {
@@ -751,7 +754,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1156,7 +1159,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return HTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1182,6 +1185,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1210,7 +1216,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) {
@@ -1251,6 +1257,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

view/ViewableData.php

Doc Comments +4 added lines, -4 removed lines

@@ -189,8 +189,6 @@ 
 	/**
 	 * Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
 	 *
-	 * @param string $field
-	 * @param array $arguments
 	 * @param string $identifier an optional custom cache identifier
 	 * @return unknown
 	 */
@@ -251,7 +249,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -501,6 +499,7 @@ 
 
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -508,6 +507,7 @@ 
 
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -515,6 +515,7 @@ 
 
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -525,7 +526,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {

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;