sunnysideup / silverstripe-modulechecks

code/api/AddFileToModule.php

Doc Comments +7 added lines, -6 removed lines

@@ -116,9 +116,8 @@ 
      * `$sourceLocation` or you can just have a string here
      * that returns the data directly....
      *
-     * @param string $fileContent
      *
-     * @return bool - true on success, false on failure
+     * @return string|false - true on success, false on failure
      */
     protected function getStandardFile()
     {
@@ -153,7 +152,8 @@ 
      * takes the standard file and adds any
      * customisations to it from the module
      *
-     * @return bool - true on success, false on failure
+     * @param string|false $fileContent
+     * @return boolean|null - true on success, false on failure
      */
     protected function customiseStandardFile($fileContent)
     {
@@ -166,7 +166,7 @@ 
      *
      * @param string $fileContent
      *
-     * @return bool - true on success, false on failure
+     * @return null|false - true on success, false on failure
      */
     protected function saveFile($fileContent)
     {
@@ -216,6 +216,9 @@ 
     }
 
 
+    /**
+     * @param string $componentName
+     */
     protected function getReadMeComponent($componentName)
     {
         $temp_dir = GitHubModule::Config()->get('absolute_temp_folder');
@@ -287,8 +290,6 @@ 
 
 
     /**
-     * @param string $file
-     * @param GitHubModule $gitObject
      *
      * @return string
      */

code/tasks/ModuleChecks.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
      *
      * @param string $name
      * @param string $variable
-     * @return boolean
+     * @return boolean|null
      */
     protected function checkForDetailsInComposerFile($name, $variable)
     {

code/objects/GitHubModule.php

Doc Comments +3 added lines

@@ -180,6 +180,9 @@
         return 'https://github.com/'.$username.'/'.$this->ModuleName;
     }
 
+    /**
+     * @param string|null $directory
+     */
     protected function IsDirGitRepo($directory)
     {
         return file_exists($directory."/.git");

code/tasks/UpdateModules.php

Doc Comments +9 added lines

@@ -322,6 +322,9 @@ 
         $configYml = ConfigYML::create($module)->reWrite();
     }
 
+    /**
+     * @param string $filename
+     */
     private function checkFile($module, $filename)
     {
         $folder = GitHubModule::Config()->get('absolute_temp_folder');
@@ -333,6 +336,9 @@ 
         return $this->checkFile($module, "README.MD");
     }
 
+    /**
+     * @param string $directory
+     */
     private function checkDirExcludedWords($directory, $wordArray)
     {
         $filesAndFolders = scandir($directory);
@@ -361,6 +367,9 @@ 
         return $problem_files;
     }
 
+    /**
+     * @param string $fileName
+     */
     private function checkFileExcludedWords($fileName, $wordArray)
     {
         $matchedWords = array();