Updates methods comments to enhance Doxygen parsing.

Dj1b · Jun 29, 2018 · 652194e · 652194e
1 parent 1506d9f
commit 652194e
Showing 1 changed file with 11 additions and 11 deletions.
diff --git a/engine/lib/object/PluginConfig.php.inc b/engine/lib/object/PluginConfig.php.inc
@@ -77,7 +77,7 @@ abstract class PluginConfig {
      */
     public $vars = null;
 
-    /*
+    /**
      * Class constructor.
      * @param string $name
      * @param Plugin $plugin
@@ -91,15 +91,15 @@ abstract class PluginConfig {
         $this->_libFile = $this->_libFolder.'/'.$this->name.'.php.inc';
     }
 
-    /*
+    /**
      * Install object.
      * @return boolean
      */
     public function install() {
         return $this->initialise() and $this->save();
     }
 
-    /*
+    /**
      * Uninstall object.
      * @return boolean
      */
@@ -136,7 +136,7 @@ abstract class PluginConfig {
         return true;
     }
 
-    /*
+    /**
      * Initialise object with default values.
      * @return boolean
      */
@@ -147,7 +147,7 @@ abstract class PluginConfig {
         return true;
     }
 
-    /*
+    /**
      * Load object from file.
      * @return boolean
      */
@@ -174,7 +174,7 @@ abstract class PluginConfig {
         return true;
     }
 
-    /*
+    /**
      * Save object to file.
      * @return boolean
      */
@@ -196,7 +196,7 @@ abstract class PluginConfig {
         return false;
     }
 
-    /*
+    /**
      * Delete object file.
      * @return boolean
      */
@@ -206,7 +206,7 @@ abstract class PluginConfig {
         return true;
     }
 
-    /*
+    /**
      * Reset object into file.
      * @return boolean success
      */
@@ -215,15 +215,15 @@ abstract class PluginConfig {
         return $this->save();
     }
 
-    /*
+    /**
      * Check object items values.
      * @return boolean
     */
     public function check_data() {
         return true;
     }
 
-    /*
+    /**
      * Load object items values from header.
      * @return void
      */
@@ -248,7 +248,7 @@ abstract class PluginConfig {
 
     /* tool methods */
 
-    /*
+    /**
      * Return locale
      * @param string $str
      * @param mixed $args