silverstripe / silverstripe-framework

view/Requirements.php

Doc Comments +6 added lines, -4 removed lines

@@ -49,6 +49,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->set_suffix_requirements($var);
@@ -109,7 +110,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_custom_scripts() {
 		return self::backend()->get_custom_scripts();
@@ -517,7 +518,7 @@ 
 	/**
 	 * Enable or disable the combination of CSS and JavaScript files
 	 * 
-	 * @param $enable
+	 * @param boolean $enable
 	 */
 	public function set_combined_files_enabled($enable) {
 		$this->combined_files_enabled = (bool) $enable;
@@ -585,6 +586,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public function set_force_js_to_bottom($var) {
 		$this->force_js_to_bottom = $var;
@@ -624,7 +626,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function get_custom_scripts() {
 		$requirements = "";
@@ -1037,7 +1039,7 @@ 
 	 * @param array  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 * 
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function combine_files($combinedFileName, $files, $media = null) {
 		// duplicate check

control/Controller.php

Doc Comments +6 added lines, -2 removed lines

@@ -306,6 +306,9 @@ 
 		return new SSViewer($templates);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function hasAction($action) {
 		return parent::hasAction($action) || $this->hasActionTemplate($action);
 	}
@@ -369,7 +372,7 @@ 
 	 * by {@link getViewer()}.
 	 *
 	 * @param array $params Key-value array for custom template variables (Optional)
-	 * @return string Parsed template content
+	 * @return HTMLText Parsed template content
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -394,6 +397,7 @@ 
 	/**
 	 * Returns the current controller
 	 * @returns Controller
+	 * @return Controller
 	 */
 	public static function curr() {
 		if(Controller::$controller_stack) {
@@ -525,7 +529,7 @@ 
 
 	/**
 	 * Tests whether a redirection has been requested.
-	 * @return string If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
+	 * @return boolean If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
 	 * return null;
 	 */
 	public function redirectedTo() {

forms/CompositeField.php

Doc Comments +6 added lines

@@ -94,6 +94,7 @@ 
 
 	/**
 	 * @param string
+	 * @param string $tag
 	 */
 	public function setTag($tag) {
 		$this->tag = $tag;
@@ -110,6 +111,7 @@ 
 
 	/**
 	 * @param string
+	 * @param string $legend
 	 */
 	public function setLegend($legend) {
 		$this->legend = $legend;
@@ -200,6 +202,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function fieldByName($name) {
 		return $this->children->fieldByName($name);
 	}
@@ -306,6 +311,7 @@ 
 	 * the children collection. Doesn't work recursively.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
 	 *             be found.
 	 */

forms/HtmlEditorField.php

Doc Comments +9 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
 	 */	
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -169,6 +169,9 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -197,7 +200,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -559,7 +562,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -597,6 +600,7 @@ 
 	 * not the "master record" in the database - hence there's no form or saving logic.
 	 *
 	 * @param String Relative or absolute URL to file
+	 * @param HtmlEditorField_File $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForFile($url, $file) {
@@ -618,6 +622,7 @@ 
 	}
 
 	/**
+	 * @param HtmlEditorField_Embed $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForOembed($url, $file) {
@@ -827,6 +832,7 @@ 
 
 	/**
 	 * @param Int
+	 * @param integer $parentID
 	 * @return DataList
 	 */
 	protected function getFiles($parentID = null) {

forms/TabSet.php

Doc Comments +6 added lines, -4 removed lines

@@ -29,8 +29,6 @@ 
 
 	/**
 	 * @param string $name Identifier
-	 * @param string $title (Optional) Natural language title of the tabset
-	 * @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet
 	 */
 	public function __construct($name) {
 		$args = func_get_args();
@@ -148,8 +146,8 @@ 
 	/**
 	 * Inserts a field before a particular field in a FieldList.
 	 *
-	 * @param FormField $item The form field to insert
-	 * @param string $name Name of the field to insert before
+	 * @param TextField $insertBefore
+	 * @param string $field
 	 */
 	public function insertBefore($insertBefore, $field) {
 		parent::insertBefore($insertBefore, $field);
@@ -157,6 +155,10 @@ 
 		$this->sequentialSet = null;
 	}
 
+	/**
+	 * @param TextField $insertAfter
+	 * @param string $field
+	 */
 	public function insertAfter($insertAfter, $field) {
 		parent::insertAfter($insertAfter, $field);
 		if($field instanceof Tab) $field->setTabSet($this);

tests/forms/HtmlEditorFieldToolbarTest.php

Doc Comments +6 added lines

@@ -5,10 +5,16 @@
 		return parent::viewfile_getLocalFileByID($id);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getLocalFileByURL($fileUrl) {
 		return parent::viewfile_getLocalFileByURL($fileUrl);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getRemoteFileByURL($fileUrl) {
 		return parent::viewfile_getRemoteFileByURL($fileUrl);
 	}

view/ViewableData.php

Doc Comments +4 added lines, -2 removed lines

@@ -233,7 +233,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');
@@ -485,6 +485,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));
@@ -492,6 +493,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));
@@ -499,6 +501,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));
@@ -509,7 +512,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) {

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)

model/Versioned.php

Doc Comments +3 added lines, -3 removed lines

@@ -798,7 +798,7 @@ 
 	/**
 	 * Get the latest published DataObject.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -817,7 +817,7 @@ 
 	/**
 	 * Move a database record from one stage to the other.
 	 *
-	 * @param int|string $fromStage Place to copy from.  Can be either a stage name or a version number.
+	 * @param integer $fromStage Place to copy from.  Can be either a stage name or a version number.
 	 * @param string $toStage Place to copy to.  Must be a stage name.
 	 * @param bool $createNewVersion Set this to true to create a new version number.
 	 *  By default, the existing version number will be copied over.
@@ -1000,6 +1000,7 @@ 
 	/**
 	 * Return the base table - the class that directly extends DataObject.
 	 *
+	 * @param string $stage
 	 * @return string
 	 */
 	public function baseTable($stage = null) {
@@ -1154,7 +1155,6 @@ 
 	 * @param string $stage The name of the stage.
 	 * @param string $filter A filter to be inserted into the WHERE clause.
 	 * @param boolean $cache Use caching.
-	 * @param string $orderby A sort expression to be inserted into the ORDER BY clause.
 	 *
 	 * @return DataObject
 	 */