Merge branch 'master' of https://github.com/unaio/una

inc/classes/BxDol.php

@@ -4,6 +4,15 @@
  * MIT License - https://opensource.org/licenses/MIT
  */
 
+/**
+ * @mainpage Index
+ * - @subpage objects Objects
+ * - @subpage service Service Calls
+ * - @subpage hooks Alerts(hooks)
+ * - @subpage public_api API Public
+ * - @subpage private_api API Private
+ */
+
 /**
  * @page objects Objects
  * Classes which represents high level programming constructions to generate ready functionality, like Comments, Votings, Forms.
@@ -121,7 +130,7 @@
  */
 
 /**
- * @page alerts Alerts (hooks)
+ * @page hooks Alerts(hooks)
  * Alerts(hooks) allow to inject custiom code into various functionality.
  */
 

inc/profiles.inc.php

@@ -128,9 +128,9 @@ function bx_login($iId, $bRememberMe = false)
     }
 
     /**
-     * @page alerts
-     * @section system System
-     * @subsection system-login 'system', 'login' - hook after user performed login
+     * @page hooks
+     * @section hooks_system System
+     * @subsection hooks_system-login 'system', 'login' - hook after user performed login
      * Used in @ref bx_login function
      * - $unit_name - `system`
      * - $action - `login` 

inc/utils.inc.php

@@ -508,9 +508,9 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     );
     
     /**
-     * @page alerts
-     * @section system System
-     * @subsection system-check_send_mail 'system', 'check_send_mail' - hook for disabling mail sending 
+     * @page hooks
+     * @section hooks_system System
+     * @subsection hooks_system-check_send_mail 'system', 'check_send_mail' - hook for disabling mail sending 
      * Used in @ref sendMail function 
      * - $unit_name - `system`
      * - $action - `check_send_mail` 
@@ -536,10 +536,10 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     // system alert
     if (!$isDisableAlert) {
         /**
-         * @page alerts
-         * @section system System
-         * @subsection system-before_send_mail 'system', 'before_send_mail' - hook before mail sending
-         * It's equivalent to @ref system-check_send_mail 
+         * @page hooks
+         * @section hooks_system System
+         * @subsection hooks_system-before_send_mail 'system', 'before_send_mail' - hook before mail sending
+         * It's equivalent to @ref hooks_system-check_send_mail 
          */
         bx_alert('system', 'before_send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert);
         if ($bResult !== null)
@@ -565,10 +565,10 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     // system alert
     if (!$isDisableAlert) {
         /**
-         * @page alerts
-         * @section system System
-         * @subsection system-send_mail 'system', 'send_mail' - hook when mail was sent
-         * It's equivalent to @ref system-check_send_mail 
+         * @page hooks
+         * @section hooks_system System
+         * @subsection hooks_system-send_mail 'system', 'send_mail' - hook when mail was sent
+         * It's equivalent to @ref hooks_system-check_send_mail 
          * except `override_result` parameter in $extra_params is missing
          */
         bx_alert('system', 'send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert);

modules/base/general/classes/BxBaseModGeneralModule.php

@@ -3154,10 +3154,10 @@ class BxBaseModGeneralModule extends BxDolModule
         $aParams = $this->_alertParams($aContentInfo);
 
         /**
-         * @page alerts
-         * @section bx_base_general Base General
-         * @subsection bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved
-         * Used in @ref BxBaseModGeneralModule::alertAfterApprove "alertAfterApprove" method
+         * @page hooks
+         * @section hooks_bx_base_general "Base General"
+         * @subsection hooks_bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved
+         * Used in @ref alertAfterApprove "alertAfterApprove" method
          * - $unit_name - module name
          * - $action - `approved` 
          * - $object_id - content id