MDL-30981 Upgrade API: Added related phpdocs
[moodle.git] / lib / db / messages.php
index db087fb..30bc820 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 /**
  * Defines message providers (types of messages being sent)
  *
- * @package    core
- * @subpackage message
- * @copyright  2008 onwards Martin Dougiamas  http://dougiamas.com
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * The providers defined on this file are processed and registered into
+ * the Moodle DB after any install or upgrade operation. All plugins
+ * support this.
+ *
+ * For more information, take a look to the documentation available:
+ *     - Message API: {@link http://docs.moodle.org/dev/Message_API}
+ *     - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
+ *
+ * @package   core
+ * @category  message
+ * @copyright 2008 onwards Martin Dougiamas  http://dougiamas.com
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
 
 $messageproviders = array (
 
-/// Notices that an admin might be interested in
+    // Notices that an admin might be interested in
     'notices' => array (
          'capability'  => 'moodle/site:config'
     ),
 
-/// Important errors that an admin ought to know about
+    // Important errors that an admin ought to know about
     'errors' => array (
          'capability'  => 'moodle/site:config'
     ),
@@ -49,17 +56,17 @@ $messageproviders = array (
         'capability'  => 'moodle/site:config'
     ),
 
-    //course creation request notification
+    // Course creation request notification
     'courserequested' => array (
         'capability'  => 'moodle/site:approvecourse'
     ),
 
-    //course request approval notification
+    // Course request approval notification
     'courserequestapproved' => array (
          'capability'  => 'moodle/course:request'
     ),
 
-    //course request rejection notification
+    // Course request rejection notification
     'courserequestrejected' => array (
         'capability'  => 'moodle/course:request'
     )