silverstripe / silverstripe-framework

src/Dev/Install/InstallRequirements.php

Doc Comments +72 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
 
     /**
      * Find the webserver software running on the PHP host.
-     * @return string|boolean Server software or boolean FALSE
+     * @return false|string Server software or boolean FALSE
      */
     public function findWebserver()
     {
@@ -469,6 +469,10 @@ 
         return ini_get($settingName);
     }
 
+    /**
+     * @param string $settingName
+     * @param string[] $testDetails
+     */
     public function suggestPHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -482,6 +486,11 @@ 
         }
     }
 
+    /**
+     * @param string $settingName
+     * @param false[] $settingValues
+     * @param string[] $testDetails
+     */
     public function requirePHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -492,6 +501,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestClass($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -501,6 +514,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestFunction($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -520,6 +537,10 @@ 
         }
     }
 
+    /**
+     * @param integer $min
+     * @param integer $recommended
+     */
     public function requireMemory($min, $recommended, $testDetails)
     {
         $_SESSION['forcemem'] = false;
@@ -635,6 +656,10 @@ 
         }
     }
 
+    /**
+     * @param string $funcName
+     * @param string[] $testDetails
+     */
     public function requireFunction($funcName, $testDetails)
     {
         $this->testing($testDetails);
@@ -646,6 +671,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $className
+     * @param string[] $testDetails
+     */
     public function requireClass($className, $testDetails)
     {
         $this->testing($testDetails);
@@ -692,6 +721,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $recommendedVersion
+     * @param string $requiredVersion
+     */
     public function requirePHPVersion($recommendedVersion, $requiredVersion, $testDetails)
     {
         $this->testing($testDetails);
@@ -735,7 +768,7 @@ 
      * to ensure the module directory is intact.
      *
      * @param string $dirname
-     * @param array $testDetails
+     * @param string[] $testDetails
      */
     public function requireModule($dirname, $testDetails)
     {
@@ -751,6 +784,10 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     * @param string[] $testDetails
+     */
     public function requireFile($filename, $testDetails)
     {
         $this->testing($testDetails);
@@ -761,6 +798,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     public function requireWriteable($filename, $testDetails, $absolute = false)
     {
         $this->testing($testDetails);
@@ -869,6 +909,10 @@ 
         }
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireApacheRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -889,6 +933,10 @@ 
         return ($this->testApacheRewriteExists() || $this->testIISRewriteModuleExists());
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireIISRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -916,6 +964,9 @@ 
         return DatabaseAdapterRegistry::getDatabaseConfigurationHelper($databaseClass);
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseFunctions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -933,6 +984,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseConnection($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -947,6 +1001,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseVersion($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -979,6 +1036,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseOrCreatePermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -1004,6 +1064,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseAlterPermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -1019,6 +1082,10 @@ 
         }
     }
 
+    /**
+     * @param string[] $varNames
+     * @param string[] $testDetails
+     */
     public function requireServerVariables($varNames, $testDetails)
     {
         $this->testing($testDetails);
@@ -1040,6 +1107,9 @@ 
     }
 
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requirePostSupport($testDetails)
     {
         $this->testing($testDetails);

src/Core/Manifest/ClassManifest.php

Doc Comments +4 added lines, -1 removed lines

@@ -258,7 +258,7 @@ 
      * Returns an array containing all the descendants (direct and indirect)
      * of a class.
      *
-     * @param  string|object $class
+     * @param  string $class
      * @return array
      */
     public function getDescendantsOf($class)
@@ -390,6 +390,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $includeTests
+     */
     public function handleFile($basename, $pathname, $includeTests)
     {
         $classes    = null;