sunnysideup / silverstripe-modulechecks

code/objects/GitHubModule.php

Doc Comments +3 added lines

@@ -175,6 +175,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 +18 added lines

@@ -360,12 +360,18 @@ 
 
     }
 
+    /**
+     * @param DataObject $module
+     */
     protected function checkConfigYML($module)
     {
         $configYml = ConfigYML::create($module)->reWrite();
 
     }
 
+    /**
+     * @param string $filename
+     */
     private function checkFile($module, $filename) {
         $folder = GitHubModule::Config()->get('absolute_temp_folder');
         return file_exists($folder.'/'.$module.'/'.$filename);
@@ -375,6 +381,9 @@ 
         return $this->checkFile($module, "README.MD");
     }
 
+    /**
+     * @param string $directory
+     */
     private function checkDirExcludedWords($directory, $wordArray) {
         $filesAndFolders = scandir ($directory);
 
@@ -404,6 +413,9 @@ 
         return $problem_files;
     }
 
+    /**
+     * @param string $fileName
+     */
     private function checkFileExcludedWords($fileName, $wordArray) {
 
 
@@ -442,6 +454,9 @@ 
 
     }
 
+    /**
+     * @param DataObject $moduleObject
+     */
     private function checkUpdateTag($moduleObject) {
 
         $tagDelayString = $this->Config()->get('tag_delay');
@@ -530,6 +545,9 @@ 
         return $newTagString;
     }
 
+    /**
+     * @param DataObject $moduleObject
+     */
     protected function moveOldReadMe($moduleObject) {
         $tempDir = GitHubModule::Config()->get('absolute_temp_folder');
         $oldReadMe = $tempDir . '/' .  $moduleObject->ModuleName . '/' .'README.md';