silverstripe / silverstripe-framework

forms/gridfield/GridField.php

Doc Comments +4 added lines, -4 removed lines

@@ -192,7 +192,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	public function getComponents() {
 		return $this->config->getComponents();
@@ -203,7 +203,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -290,7 +290,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -604,7 +604,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$this->extend('onBeforeRender', $this);

model/connect/MySQLStatement.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,8 +78,8 @@
 
 	/**
 	 * Hook the result-set given into a Query class, suitable for use by SilverStripe.
-	 * @param mysqli_stmt $statement The related statement, if present
-	 * @param mysqli_result $metadata The metadata for this statement
+	 * @param \mysqli_stmt $statement The related statement, if present
+	 * @param \mysqli_result $metadata The metadata for this statement
 	 */
 	public function __construct($statement, $metadata) {
 		$this->statement = $statement;

model/versioning/ChangeSetItem.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,7 +132,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -141,7 +141,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);
@@ -325,7 +325,7 @@ 
 	 * Get the ChangeSetItems that reference a passed DataObject
 	 *
 	 * @param DataObject $object
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object($object) {
 		return ChangeSetItem::get()->filter([
@@ -339,7 +339,7 @@ 
 	 *
 	 * @param int $objectID The ID of the object
 	 * @param string $objectClass The class of the object (or any parent class)
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object_by_id($objectID, $objectClass) {
 		return ChangeSetItem::get()->filter([

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -728,7 +728,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -782,7 +782,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

api/RSSFeed.php

Doc Comments +3 added lines, -1 removed lines

@@ -191,7 +191,7 @@ 
 	 *
 	 * TODO: Pass $response object to ->outputToBrowser() to loosen dependence on global state for easier testing/prototyping so dev can inject custom SS_HTTPResponse instance.
 	 *
-	 * @return	HTMLText
+	 * @return	DBField
 	 */
 	public function outputToBrowser() {
 		$prevState = Config::inst()->get('SSViewer', 'source_file_comments');
@@ -222,6 +222,7 @@ 
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;
@@ -318,6 +319,7 @@ 
 	/**
 	 * Return the named field as an obj() call from $this->failover.
 	 * Default to the given class if there's no casting information.
+	 * @param string $fieldName
 	 */
 	public function rssField($fieldName, $defaultClass = 'Varchar') {
 		if($fieldName) {

forms/HTMLEditorSanitiser.php

Doc Comments +3 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -182,6 +182,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {
@@ -245,7 +246,7 @@ 
 	 * Given an SS_HTMLValue instance, will remove and elements and attributes that are
 	 * not explicitly included in the whitelist passed to __construct on instance creation
 	 *
-	 * @param SS_HTMLValue $html - The HTMLValue to remove any non-whitelisted elements & attributes from
+	 * @param HTMLValue $html - The HTMLValue to remove any non-whitelisted elements & attributes from
 	 */
 	public function sanitise (HTMLValue $html) {
 		if(!$this->elements && !$this->elementPatterns) return;

model/DataObject.php

Doc Comments +8 added lines, -3 removed lines

@@ -588,8 +588,8 @@ 
 
 	/**
 	 * Helper function to duplicate relations from one object to another
-	 * @param $sourceObject the source object to duplicate from
-	 * @param $destinationObject the destination object to populate with the duplicated relations
+	 * @param DataObject $sourceObject the source object to duplicate from
+	 * @param DataObject $destinationObject the destination object to populate with the duplicated relations
 	 * @param $name the name of the relation to duplicate (e.g. members)
 	 */
 	private function duplicateRelations($sourceObject, $destinationObject, $name) {
@@ -987,6 +987,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -2273,6 +2274,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2751,6 +2753,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -3097,7 +3100,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3376,6 +3379,7 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3383,6 +3387,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {