silverstripe / silverstripe-framework

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());

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -369,7 +369,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -443,6 +442,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -843,7 +846,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -873,7 +876,7 @@ 
 	}
 
 	/**
-	 * @param string|array $templateList If passed as a string with .ss extension, used as the "main" template.
+	 * @param string|array $templates If passed as a string with .ss extension, used as the "main" template.
 	 *  If passed as an array, it can be used for template inheritance (first found template "wins").
 	 *  Usually the array values are PHP class names, which directly correlate to template names.
 	 *  <code>
@@ -1227,7 +1230,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBHTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1253,6 +1256,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1282,7 +1288,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1323,6 +1329,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

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

view/TemplateLoader.php

Doc Comments +9 added lines, -2 removed lines

@@ -24,10 +24,17 @@ 
 		self::$instance = $instance;
 	}
 
+	/**
+	 * @param string $base
+	 */
 	public function __construct($base = null) {
 		$this->base = $base ? $base : BASE_PATH;
 	}
 
+	/**
+	 * @param string $set
+	 * @param ThemeManifest $manifest
+	 */
 	public function addSet($set, $manifest) {
 		$this->sets[$set] = $manifest;
 	}
@@ -72,8 +79,8 @@ 
 	 * format "type/name", where type is the type of template to search for
 	 * (e.g. Includes, Layout).
 	 *
-	 * @param  string|array $templates
-	 * @param  string $theme
+	 * @param  string|array $template
+	 * @param  string $themes
 	 *
 	 * @return array
 	 */

view/ViewableData.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -295,7 +295,7 @@ 
 	 *
 	 * @param string|array|SSViewer $template the template to render into
 	 * @param array $customFields fields to customise() the object with before rendering
-	 * @return DBHTMLText
+	 * @return SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function renderWith($template, $customFields = null) {
 		if(!is_object($template)) {