silverstripe / silverstripe-framework

core/Object.php

Doc Comments +8 added lines, -9 removed lines

@@ -125,8 +125,6 @@ 
 	 *    $list = DataList::create('SiteTree');
 	 *	  $list = SiteTree::get();
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function create() {
@@ -149,7 +147,6 @@ 
 	 * way to access instance methods which don't rely on instance
 	 * data (e.g. the custom SilverStripe static handling).
 	 *
-	 * @param string $className Optional classname (if called on Object directly)
 	 * @return static The singleton instance
 	 */
 	public static function singleton() {
@@ -334,8 +331,6 @@ 
 	 * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to
 	 * TRUE when using {@link Object::useCustomClass()}
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function strong_create() {
@@ -387,8 +382,8 @@ 
 	 * without any inheritance, merging or parent lookup if it doesn't exist on the given class.
 	 *
 	 * @static
-	 * @param $class - The class to get the static from
-	 * @param $name - The property to get from the class
+	 * @param string $class - The class to get the static from
+	 * @param string $name - The property to get from the class
 	 * @param null $default - The value to return if property doesn't exist on class
 	 * @return any - The value of the static property $name on class $class, or $default if that property is not
 	 *               defined
@@ -914,6 +909,7 @@ 
 
 	/**
 	 * @see Object::get_static()
+	 * @param string $name
 	 */
 	public function stat($name, $uncached = false) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET);
@@ -921,6 +917,8 @@ 
 
 	/**
 	 * @see Object::set_static()
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function set_stat($name, $value) {
 		Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value);
@@ -928,6 +926,7 @@ 
 
 	/**
 	 * @see Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -978,7 +977,7 @@ 
 	 * all results into an array
 	 *
 	 * @param string $method the method name to call
-	 * @param mixed $argument a single argument to pass
+	 * @param string $argument a single argument to pass
 	 * @return mixed
 	 * @todo integrate inheritance rules
 	 */
@@ -1001,7 +1000,7 @@ 
 	 * The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
 	 *
 	 * @param string $method the name of the method to call on each extension
-	 * @param mixed $a1,... up to 7 arguments to be passed to the method
+	 * @param DataObject $a4
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {

dev/DebugView.php

Doc Comments +1 added lines

@@ -126,6 +126,7 @@
 	 *
 	 * @param string $title
 	 * @param string $title
+	 * @param string|false $subtitle
 	 */
 	public function writeInfo($title, $subtitle, $description=false) {
 		echo '<div class="info">';

dev/SapphireTest.php

Doc Comments +11 added lines, -9 removed lines

@@ -142,6 +142,7 @@ 
 
 	/**
 	 * Set the manifest to be used to look up test classes by helper functions
+	 * @param SS_ClassManifest $manifest
 	 */
 	public static function set_test_class_manifest($manifest) {
 		self::$test_class_manifest = $manifest;
@@ -394,7 +395,7 @@ 
 	/**
 	 * Get the ID of an object from the fixture.
 	 *
-	 * @param $className The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $className The data class, as specified in your fixture file.  Parent classes won't work
 	 * @param $identifier The identifier string, as provided in your fixture file
 	 * @return int
 	 */
@@ -417,7 +418,7 @@ 
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
 	 *
 	 * @param string $className
-	 * @return array A map of fixture-identifier => object-id
+	 * @return A A map of fixture-identifier => object-id
 	 */
 	protected function allFixtureIDs($className) {
 		return $this->getFixtureFactory()->getIds($className);
@@ -574,10 +575,10 @@ 
 	/**
 	 * Assert that the matching email was sent since the last call to clearEmails()
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-	 * @param $to
+	 * @param string $to
 	 * @param $from
-	 * @param $subject
-	 * @param $content
+	 * @param string $subject
+	 * @param string $content
 	 * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
 	 *               'customHeaders', 'htmlContent', inlineImages'
 	 */
@@ -738,7 +739,7 @@ 
 	 * @param string $expectedSQL
 	 * @param string $actualSQL
 	 * @param string $message
-	 * @param float $delta
+	 * @param integer $delta
 	 * @param integer $maxDepth
 	 * @param boolean $canonicalize
 	 * @param boolean $ignoreCase
@@ -937,6 +938,7 @@ 
 	/**
 	 * Create a member and group with the given permission code, and log in with it.
 	 * Returns the member ID.
+	 * @return integer
 	 */
 	public function logInWithPermission($permCode = "ADMIN") {
 		if(!isset($this->cache_generatedMembers[$permCode])) {
@@ -976,9 +978,9 @@ 
 	/**
 	 * Test against a theme.
 	 *
-	 * @param $themeBaseDir string - themes directory
-	 * @param $theme string - theme name
-	 * @param $callback Closure
+	 * @param string $themeBaseDir string - themes directory
+	 * @param string $theme string - theme name
+	 * @param Closure $callback Closure
 	 */
 	protected function useTestTheme($themeBaseDir, $theme, $callback) {
 		Config::nest();

filesystem/Upload.php

Doc Comments +5 added lines, -4 removed lines

@@ -102,7 +102,7 @@ 
 	 * Set a different instance than {@link Upload_Validator}
 	 * for this upload session.
 	 *
-	 * @param object $validator
+	 * @param Upload_Validator $validator
 	 */
 	public function setValidator($validator) {
 		$this->validator = $validator;
@@ -223,7 +223,7 @@ 
 	 *
 	 * @param array $tmpFile
 	 * @param File $file
-	 * @return Boolean
+	 * @return boolean|string
 	 */
 	public function loadIntoFile($tmpFile, $file, $folderPath = false) {
 		$this->file = $file;
@@ -231,7 +231,8 @@ 
 	}
 
 	/**
-	 * @return Boolean
+	 * @param boolean $bool
+	 * @return boolean|null
 	 */
 	public function setReplaceFile($bool) {
 		$this->replaceFile = $bool;
@@ -295,7 +296,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));

forms/HtmlEditorField.php

Doc Comments +10 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,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -197,7 +201,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(
@@ -563,7 +567,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -607,6 +611,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) {
@@ -628,6 +633,7 @@ 
 	}
 
 	/**
+	 * @param HtmlEditorField_Embed $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForOembed($url, $file) {
@@ -837,6 +843,7 @@ 
 
 	/**
 	 * @param Int
+	 * @param integer $parentID
 	 * @return DataList
 	 */
 	protected function getFiles($parentID = null) {

forms/PhoneNumberField.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function joinPhoneNumber( $value ) {
 		if( is_array( $value ) ) {
 			$completeNumber = '';

forms/TreeDropdownField.php

Doc Comments +3 added lines, -4 removed lines

@@ -76,7 +76,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -204,7 +204,7 @@ 
 	}
 
 	/**
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -385,7 +385,7 @@ 
 	 * If a filter function has been set, that will be called. And if search text is set,
 	 * filter on that too. Return true if all applicable conditions are true, false otherwise.
 	 * @param $node
-	 * @return unknown_type
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
@@ -436,7 +436,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;

model/connect/Database.php

Doc Comments +4 added lines, -1 removed lines

@@ -385,6 +385,7 @@ 
 	 * - minutes
 	 * - seconds
 	 * This includes the singular forms as well
+	 * @param string $date
 	 * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of
 	 *                the addition
 	 */
@@ -398,6 +399,7 @@ 
 	 *                       e.g. '"SiteTree"."Created"'
 	 * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime
 	 *                      like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
+	 * @param string $date1
 	 * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which
 	 *                is the result of the substraction
 	 */
@@ -625,7 +627,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -785,6 +787,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

model/Image.php

Doc Comments +4 added lines, -4 removed lines

@@ -589,7 +589,7 @@ 
 	/**
 	 * Resize this image for the CMS. Use in templates with $CMSThumbnail
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function CMSThumbnail() {
 		return $this->Pad($this->stat('cms_thumbnail_width'),$this->stat('cms_thumbnail_height'));
@@ -631,7 +631,7 @@ 
 	/**
 	 * Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
 	 *
-	 * @return Image_Cached|null
+	 * @return Image|null
 	 */
 	public function StripThumbnail() {
 		return $this->Fill($this->stat('strip_thumbnail_width'),$this->stat('strip_thumbnail_height'));
@@ -868,7 +868,7 @@ 
 	/**
 	 * Generate patterns that will help to match filenames of cached images
 	 * @param string $filename Filename of source image
-	 * @return array
+	 * @return string
 	 */
 	private function getFilenamePatterns($filename) {
 		$methodNames = $this->allMethodNames(true);
@@ -1024,7 +1024,7 @@ 
 
 	/**
 	 * Get the orientation of this image.
-	 * @return ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
+	 * @return integer | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
 	 */
 	public function getOrientation() {
 		$width = $this->getWidth();