Partial revert of #7665 - bad docblock changes

This commit is contained in:
Daniel Hensby 2018-02-09 19:27:11 +00:00
parent 5d00d28b2f
commit 85e97d204b
No known key found for this signature in database
GPG Key ID: B00D1E9767F0B06E
18 changed files with 33 additions and 33 deletions

View File

@ -16,7 +16,7 @@ interface AfterCallAspect {
/** /**
* Call this aspect after a method is executed * Call this aspect after a method is executed
* *
* @param SS_Object $proxied * @param object $proxied
* The object having the method called upon it. * The object having the method called upon it.
* @param string $method * @param string $method
* The name of the method being called * The name of the method being called

View File

@ -14,7 +14,7 @@ interface BeforeCallAspect {
/** /**
* Call this aspect before a method is executed * Call this aspect before a method is executed
* *
* @param SS_Object $proxied * @param object $proxied
* The object having the method called upon it. * The object having the method called upon it.
* @param string $method * @param string $method
* The name of the method being called * The name of the method being called

View File

@ -356,7 +356,7 @@ class Injector {
* *
* @param string $property * @param string $property
* the name of the property * the name of the property
* @param SS_Object $object * @param object $object
* the object to be set * the object to be set
*/ */
public function addAutoProperty($property, $object) { public function addAutoProperty($property, $object) {
@ -585,7 +585,7 @@ class Injector {
* into them, so we can update that binding at a later point if needbe (ie * into them, so we can update that binding at a later point if needbe (ie
* if the managed service changes) * if the managed service changes)
* *
* @param SS_Object $object * @param object $object
* The object to inject * The object to inject
* @param string $asType * @param string $asType
* The ID this item was loaded as. This is so that the property configuration * The ID this item was loaded as. This is so that the property configuration
@ -694,7 +694,7 @@ class Injector {
/** /**
* Helper to set a property's value * Helper to set a property's value
* *
* @param SS_Object $object * @param object $object
* Set an object's property to a specific value * Set an object's property to a specific value
* @param string $name * @param string $name
* The name of the property to set * The name of the property to set

View File

@ -76,7 +76,7 @@ class ClassInfo {
* Returns an array of the current class and all its ancestors and children * Returns an array of the current class and all its ancestors and children
* which require a DB table. * which require a DB table.
* *
* @param string|SS_Object $class * @param string|object $class
* @todo Move this into data object * @todo Move this into data object
* @return array * @return array
*/ */
@ -103,7 +103,7 @@ class ClassInfo {
* Returns the root class (the first to extend from DataObject) for the * Returns the root class (the first to extend from DataObject) for the
* passed class. * passed class.
* *
* @param string|SS_Object $class * @param string|object $class
* @return string * @return string
*/ */
public static function baseDataClass($class) { public static function baseDataClass($class) {
@ -162,7 +162,7 @@ class ClassInfo {
* *
* eg: self::class_name('dataobJEct'); //returns 'DataObject' * eg: self::class_name('dataobJEct'); //returns 'DataObject'
* *
* @param string|SS_Object $nameOrObject The classname or object you want to normalise * @param string|object $nameOrObject The classname or object you want to normalise
* *
* @return string The normalised class name * @return string The normalised class name
*/ */

View File

@ -214,7 +214,7 @@ class Convert {
* Convert a JSON encoded string into an object. * Convert a JSON encoded string into an object.
* *
* @param string $val * @param string $val
* @return SS_Object|boolean * @return object|boolean
*/ */
public static function json2obj($val) { public static function json2obj($val) {
return json_decode($val); return json_decode($val);

View File

@ -549,7 +549,7 @@ class Diff
* *
* $diff = new Diff($lines1, $lines2); * $diff = new Diff($lines1, $lines2);
* $rev = $diff->reverse(); * $rev = $diff->reverse();
* @return SS_Object A Diff object representing the inverse of the * @return object A Diff object representing the inverse of the
* original diff. * original diff.
*/ */
public function reverse () { public function reverse () {
@ -665,7 +665,7 @@ class Diff
* by passing through DomDocument::loadHTML and saveXML * by passing through DomDocument::loadHTML and saveXML
* *
* @param string $content HTML content * @param string $content HTML content
* @param SS_Object $cleaner Optional instance of a HTMLCleaner class to * @param object $cleaner Optional instance of a HTMLCleaner class to
* use, overriding self::$html_cleaner_class * use, overriding self::$html_cleaner_class
*/ */
public static function cleanHTML($content, $cleaner=null) { public static function cleanHTML($content, $cleaner=null) {

View File

@ -840,7 +840,7 @@ abstract class SS_Object {
} }
/** /**
* @param SS_Object $extension * @param object $extension
* @return array * @return array
*/ */
protected function findMethodsFromExtension($extension) { protected function findMethodsFromExtension($extension) {

View File

@ -211,7 +211,7 @@ class SS_ClassManifest {
* Returns an array containing all the descendants (direct and indirect) * Returns an array containing all the descendants (direct and indirect)
* of a class. * of a class.
* *
* @param string|SS_Object $class * @param string|object $class
* @return array * @return array
*/ */
public function getDescendantsOf($class) { public function getDescendantsOf($class) {

View File

@ -215,7 +215,7 @@ class DebugView extends SS_Object {
/** /**
* Outputs a variable in a user presentable way * Outputs a variable in a user presentable way
* *
* @param SS_Object $val * @param object $val
* @param array $caller Caller information * @param array $caller Caller information
*/ */
public function writeVariable($val, $caller) { public function writeVariable($val, $caller) {

View File

@ -61,7 +61,7 @@ class SS_Log {
/** /**
* @see SS_Log::get_logger() * @see SS_Log::get_logger()
* @var SS_Object * @var object
*/ */
protected static $logger; protected static $logger;
@ -86,7 +86,7 @@ class SS_Log {
/** /**
* Get the logger currently in use, or create a new one if it doesn't exist. * Get the logger currently in use, or create a new one if it doesn't exist.
* *
* @return SS_Object * @return object
*/ */
public static function get_logger() { public static function get_logger() {
if(!static::$logger) { if(!static::$logger) {
@ -122,7 +122,7 @@ class SS_Log {
/** /**
* Remove a writer instance from the logger. * Remove a writer instance from the logger.
* @param SS_Object $writer Zend_Log_Writer_Abstract instance * @param object $writer Zend_Log_Writer_Abstract instance
*/ */
public static function remove_writer($writer) { public static function remove_writer($writer) {
static::get_logger()->removeWriter($writer); static::get_logger()->removeWriter($writer);
@ -130,7 +130,7 @@ class SS_Log {
/** /**
* Add a writer instance to the logger. * Add a writer instance to the logger.
* @param SS_Object $writer Zend_Log_Writer_Abstract instance * @param object $writer Zend_Log_Writer_Abstract instance
* @param const $priority Priority. Possible values: SS_Log::ERR, SS_Log::WARN or SS_Log::NOTICE * @param const $priority Priority. Possible values: SS_Log::ERR, SS_Log::WARN or SS_Log::NOTICE
* @param $comparison Priority comparison operator. Acts on the integer values of the error * @param $comparison Priority comparison operator. Acts on the integer values of the error
* levels, where more serious errors are lower numbers. By default this is "=", which means only * levels, where more serious errors are lower numbers. By default this is "=", which means only

View File

@ -23,7 +23,7 @@ class SS_ZendLog extends Zend_Log {
/** /**
* Remove a writer instance that exists in this logger. * Remove a writer instance that exists in this logger.
* @param SS_Object Zend_Log_Writer_Abstract instance * @param object Zend_Log_Writer_Abstract instance
*/ */
public function removeWriter($writer) { public function removeWriter($writer) {
foreach($this->_writers as $index => $existingWriter) { foreach($this->_writers as $index => $existingWriter) {

View File

@ -185,7 +185,7 @@ class File extends DataObject {
* Replace "[file_link id=n]" shortcode with an anchor tag or link to the file. * Replace "[file_link id=n]" shortcode with an anchor tag or link to the file.
* @param $arguments array Arguments to the shortcode * @param $arguments array Arguments to the shortcode
* @param $content string Content of the returned link (optional) * @param $content string Content of the returned link (optional)
* @param $parser SS_Object Specify a parser to parse the content (see {@link ShortCodeParser}) * @param $parser object Specify a parser to parse the content (see {@link ShortCodeParser})
* @return string anchor HTML tag if content argument given, otherwise file path link * @return string anchor HTML tag if content argument given, otherwise file path link
*/ */
public static function link_shortcode_handler($arguments, $content = null, $parser = null) { public static function link_shortcode_handler($arguments, $content = null, $parser = null) {

View File

@ -102,7 +102,7 @@ class Upload extends Controller {
* Set a different instance than {@link Upload_Validator} * Set a different instance than {@link Upload_Validator}
* for this upload session. * for this upload session.
* *
* @param SS_Object $validator * @param object $validator
*/ */
public function setValidator($validator) { public function setValidator($validator) {
$this->validator = $validator; $this->validator = $validator;

View File

@ -37,7 +37,7 @@ class GridState extends HiddenField {
/** /**
* @param mixed $d * @param mixed $d
* @return SS_Object * @return object
*/ */
public static function array_to_object($d) { public static function array_to_object($d) {
if(is_array($d)) { if(is_array($d)) {

View File

@ -171,8 +171,8 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
/** /**
* Replaces an item in this list with another item. * Replaces an item in this list with another item.
* *
* @param array|SS_Object $item * @param array|object $item
* @param array|SS_Object $with * @param array|object $with
* @return void; * @return void;
*/ */
public function replace($item, $with) { public function replace($item, $with) {
@ -188,7 +188,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
* Merges with another array or list by pushing all the items in it onto the * Merges with another array or list by pushing all the items in it onto the
* end of this list. * end of this list.
* *
* @param array|SS_Object $with * @param array|object $with
*/ */
public function merge($with) { public function merge($with) {
foreach ($with as $item) $this->push($item); foreach ($with as $item) $this->push($item);
@ -221,7 +221,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
/** /**
* Pushes an item onto the end of this list. * Pushes an item onto the end of this list.
* *
* @param array|SS_Object $item * @param array|object $item
*/ */
public function push($item) { public function push($item) {
$this->items[] = $item; $this->items[] = $item;
@ -230,7 +230,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
/** /**
* Pops the last element off the end of the list and returns it. * Pops the last element off the end of the list and returns it.
* *
* @return array|SS_Object * @return array|object
*/ */
public function pop() { public function pop() {
return array_pop($this->items); return array_pop($this->items);
@ -239,7 +239,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
/** /**
* Add an item onto the beginning of the list. * Add an item onto the beginning of the list.
* *
* @param array|SS_Object $item * @param array|object $item
*/ */
public function unshift($item) { public function unshift($item) {
array_unshift($this->items, $item); array_unshift($this->items, $item);
@ -248,7 +248,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
/** /**
* Shifts the item off the beginning of the list and returns it. * Shifts the item off the beginning of the list and returns it.
* *
* @return array|SS_Object * @return array|object
*/ */
public function shift() { public function shift() {
return array_shift($this->items); return array_shift($this->items);
@ -725,7 +725,7 @@ class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sorta
* Extracts a value from an item in the list, where the item is either an * Extracts a value from an item in the list, where the item is either an
* object or array. * object or array.
* *
* @param array|SS_Object $item * @param array|object $item
* @param string $key * @param string $key
* @return mixed * @return mixed
*/ */

View File

@ -85,7 +85,7 @@ class UnsavedRelationList extends ArrayList {
/** /**
* Pushes an item onto the end of this list. * Pushes an item onto the end of this list.
* *
* @param array|SS_Object $item * @param array|object $item
* @param array $extraFields * @param array $extraFields
*/ */
public function push($item, $extraFields = null) { public function push($item, $extraFields = null) {

View File

@ -21,7 +21,7 @@ class ArrayData extends ViewableData {
protected $array; protected $array;
/** /**
* @param SS_Object|array $value An associative array, or an object with simple properties. * @param object|array $value An associative array, or an object with simple properties.
* Converts object properties to keys of an associative array. * Converts object properties to keys of an associative array.
*/ */
public function __construct($value) { public function __construct($value) {

View File

@ -131,7 +131,7 @@ class SSViewer_Scope {
/** /**
* Gets the current object and resets the scope. * Gets the current object and resets the scope.
* *
* @return SS_Object * @return object
*/ */
public function self() { public function self() {
$result = $this->itemIterator ? $this->itemIterator->current() : $this->item; $result = $this->itemIterator ? $this->itemIterator->current() : $this->item;