Cleanup Code

aljawaid · Sep 28, 2023 · 453b87a · 453b87a
1 parent 6bffef7
commit 453b87a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/Controller/URLCleanerController.php b/Controller/URLCleanerController.php
@@ -7,7 +7,9 @@
 
 /**
  * Plugin URLCleaner
+ *
  * Class URLCleanerController
+ * @package  Kanboard\Controller
  * @author aljawaid
  */
 
@@ -31,7 +33,7 @@ public function show()
     }
 
     /**
-     * Save settings
+     * Save Settings
      *
      */
     public function save()

diff --git a/Helper/CleanURLHelper.php b/Helper/CleanURLHelper.php
@@ -4,8 +4,22 @@
 
 use Kanboard\Core\Base;
 
+/**
+ * Plugin URLCleaner
+ * Class CleanURLHelper
+ *
+ * @package  Plugin\URLCleaner\Helper
+ * @author   aljawaid
+ */
 class CleanURLHelper extends Base
 {
+    /**
+     * Get Before and After Routes
+     *
+     * @see     url-cleaner.php
+     * @return  string
+     * @author  aljawaid
+     */
     public function newCoreRoutes()
     {
         return array(

diff --git a/Plugin.php b/Plugin.php
@@ -100,8 +100,7 @@ public function onStartup()
 
     public function getPluginName()
     {
-        // Plugin Name MUST be identical to namespace for Plugin Directory to detect updated versions
-        // Do not translate the plugin name here
+        // Plugin Name MUST be identical to namespace for Plugin Directory to detect updated versions - do not translate the plugin name here
         return 'URLCleaner';
     }