Merge pull request #81 from prestaforum/prestaforum-patch-2

Improve some comments in the code

Author: PierreRambaud

ps_googleanalytics.php

@@ -66,7 +66,7 @@ public function __construct()
     }
 
     /**
-     * back office module configuration page content
+     * Back office module configuration page content
      */
     public function getContent()
     {
@@ -91,7 +91,8 @@ public function hookDisplayHeader($params, $back_office = false)
     }
 
     /**
-     * To track transactions
+     * Confirmation page hook.
+     * This function is run to track transactions.
      */
     public function hookDisplayOrderConfirmation($params)
     {
@@ -102,7 +103,8 @@ public function hookDisplayOrderConfirmation($params)
     }
 
     /**
-     * hook footer to load JS script for standards actions such as product clicks
+     * Footer hook.
+     * This function is run to load JS script for standards actions such as product clicks
      */
     public function hookDisplayFooter()
     {
@@ -112,7 +114,8 @@ public function hookDisplayFooter()
     }
 
     /**
-     * hook home to display generate the product list associated to home featured, news products and best sellers Modules
+     * Homepage hook.
+     * This function is run to manage analytics for product list associated to home featured, news products and best sellers Modules
      */
     public function hookDisplayHome()
     {
@@ -122,7 +125,8 @@ public function hookDisplayHome()
     }
 
     /**
-     * hook product page footer to load JS for product details view
+     * Product page footer hook
+     * This function is run to load JS for product details view
      */
     public function hookDisplayFooterProduct($params)
     {
@@ -133,7 +137,8 @@ public function hookDisplayFooterProduct($params)
     }
 
     /**
-     * Hook admin order to send transactions and refunds details
+     * Hook admin order.
+     * This function is run to send transactions and refunds details
      */
     public function hookDisplayAdminOrder()
     {
@@ -147,7 +152,8 @@ public function hookDisplayAdminOrder()
     }
 
     /**
-     *  admin office header to add google analytics js
+     * Admin office header hook.
+     * This function is run to add Google Analytics JavaScript
      */
     public function hookDisplayBackOfficeHeader()
     {
@@ -157,7 +163,8 @@ public function hookDisplayBackOfficeHeader()
     }
 
     /**
-     * Hook admin office header to add google analytics js
+     * Product cancel action hook (in Back office).
+     * This function is run to add Google Analytics JavaScript
      */
     public function hookActionProductCancel($params)
     {
@@ -167,7 +174,8 @@ public function hookActionProductCancel($params)
     }
 
     /**
-     * hook save cart event to implement addtocart and remove from cart functionality
+     * Save cart event hook.
+     * This function is run to implement 'add to cart' and 'remove from cart' functionalities
      */
     public function hookActionCartSave()
     {
@@ -196,9 +204,9 @@ protected function _debugLog($function, $log)
     }
 
     /**
-     * This method is trigger at the installation of the module
-     * - install all module tables
-     * - register hook used by the module.
+     * This method is triggered at the installation of the module
+     * - it installs all module tables
+     * - it registers the hooks used by this module
      *
      * @return bool
      */
@@ -216,7 +224,7 @@ public function install()
 
     /**
      * Triggered at the uninstall of the module
-     * - erase tables
+     * - erases this module SQL tables
      *
      * @return bool
      */