silverstripe / silverstripe-framework

forms/UploadField.php

Doc Comments +5 added lines, -5 removed lines

@@ -285,7 +285,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) return false;
@@ -638,7 +638,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) return false;
@@ -662,7 +662,7 @@ 
 	 * Determine if the user has permission to attach existing files
 	 * By default returns true if the user has the CMS_ACCESS_AssetAdmin permission
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canAttachExisting() {
 		if(!$this->isActive()) return false;
@@ -1094,7 +1094,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1457,7 +1457,7 @@ 
 	 * Action to handle editing of a single file
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return DBHTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

ORM/Connect/DBSchemaManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -475,7 +475,7 @@
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {

ORM/FieldType/DBField.php

Doc Comments +2 added lines, -2 removed lines

@@ -276,7 +276,7 @@ 
 	/**
 	 * Get the table this field belongs to, if assigned
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getTable() {
 		return $this->tableName;
@@ -476,7 +476,7 @@ 
 	}
 
 	/**
-	 * @param array $value
+	 * @param string $value
 	 * @return $this
 	 */
 	public function setArrayValue($value) {

Security/Security.php

Doc Comments +5 added lines, -5 removed lines

@@ -507,7 +507,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -795,7 +795,7 @@ 
 	 * For use in any subclass.
 	 *
 	 * @param string $name
-	 * @return array Returns the template(s) for rendering
+	 * @return string[] Returns the template(s) for rendering
 	 */
 	public function getIncludeTemplate($name) {
 		return array('Security_' . $name);
@@ -883,7 +883,7 @@ 
 	 *
 	 * @param string $username The user name
 	 * @param string $password The password (in cleartext)
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function setDefaultAdmin($username, $password) {
 		// don't overwrite if already set
@@ -970,7 +970,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1138,7 +1138,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

thirdparty/jsmin/jsmin.php

Doc Comments +14 added lines

@@ -59,6 +59,9 @@ 
 

   // -- Public Static Methods --------------------------------------------------

 

+  /**
+   * @param string $js
+   */
   public static function minify($js) {

     $jsmin = new JSMin($js);

     return $jsmin->min();

@@ -82,6 +85,10 @@ 
      action treats a string as a single character. Wow!

      action recognizes a regular expression if it is preceded by ( or , or =.

   */

+
+  /**
+   * @param integer $d
+   */
   protected function action($d) {

     switch($d) {

       case 1:

@@ -160,6 +167,9 @@ 
     }

   }

 

+  /**
+   * @return string
+   */
   protected function get() {

     $c = $this->lookAhead;

     $this->lookAhead = null;

@@ -187,6 +197,10 @@ 
   /* isAlphanum -- return true if the character is a letter, digit, underscore,

         dollar sign, or non-ASCII character.

   */

+
+  /**
+   * @param string $c
+   */
   protected function isAlphaNum($c) {

     return ord($c) > 126 || $c === '\\' || preg_match('/^[\w\$]$/', $c) === 1;

   }

forms/ListboxField.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 	 *
 	 * @param array $properties
 	 *
-	 * @return string
+	 * @return SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		$source = ArrayLib::flatten($this->getSource());

forms/ReadonlyField.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * If $dontEscape is false the returned value will be safely encoded,
 	 * but should not be escaped by the frontend.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function Value() {
 		// Get raw value

forms/FormField.php

Doc Comments +3 added lines, -4 removed lines

@@ -760,7 +760,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1184,7 +1183,7 @@ 
 	/**
 	 * @param FormTransformation $transformation
 	 *
-	 * @return mixed
+	 * @return FormField
 	 */
 	public function transform(FormTransformation $transformation) {
 		return $transformation->transform($this);
@@ -1287,7 +1286,7 @@ 
 	 * This function is used by the template processor. If you refer to a field as a $ variable, it
 	 * will return the $Field value.
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function forTemplate() {
 		return $this->Field();
@@ -1309,7 +1308,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;

forms/TextField.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	}
 
 	/**
-	 * @return null|int
+	 * @return integer
 	 */
 	public function getMaxLength() {
 		return $this->maxLength;
@@ -73,7 +73,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function InternallyLabelledField() {
 		Deprecation::notice('4.0', 'Please use ->setValue() instead');