Tw17194599 (#17)

* Added doc headers to all required files. * TW17194599 Updating version and contributions.
brickfield · Jul 5, 2021 · 0d568fe · 0d568fe
1 parent 71e522c
commit 0d568fe
Show file tree

Hide file tree

Showing 29 changed files with 194 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,10 @@ This plugin has been developed to work on Moodle releases 3.9, 3.10, and 3.11.
 ## Development ##
 This Plugin has been developed and is maintained by Brickfield Education Labs.
 If you wish to contribute funding to the ongoing development of features and / or
-maintenance of the plugin - please contact support@brickfield.ie.
+maintenance of the plugin - please contact [support@brickfield.ie](mailto:support@brickfield.ie).
+
+This module uses code derived from ["jquery.editable.amd.js"](https://github.com/victorjonsson/jquery-editable/).
+This code written by [Victor Jonsson](http://victorjonsson.se/) is licensed under [GNU GPLv2](http://www.gnu.org/licenses/gpl-2.0.html).
 
 ## Documentation ##
 All public documentation for this plugin will be maintained at the

diff --git a/amd/src/board.js b/amd/src/board.js
@@ -16,8 +16,9 @@
 /**
  * A javascript module to handle the board.
  *
- * @module     mod_board/board
  * @package    mod_board
+ * @author     Karen Holland <karen@brickfieldlabs.ie>
+ * @copyrigt   2021 Brickfield Education Labs <https://www.brickfield.ie/>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

diff --git a/amd/src/main.js b/amd/src/main.js
@@ -16,8 +16,9 @@
 /**
  * A javascript module to handle the board.
  *
- * @module     mod_board/main
  * @package    mod_board
+ * @author     Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright  2021 Brickfield Education Labs <https://www.brickfield.ie/>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

diff --git a/backup/moodle2/backup_board_activity_task.class.php b/backup/moodle2/backup_board_activity_task.class.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->dirroot . '/mod/board/backup/moodle2/backup_board_stepslib.php');

diff --git a/backup/moodle2/backup_board_stepslib.php b/backup/moodle2/backup_board_stepslib.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 class backup_board_activity_structure_step extends backup_activity_structure_step {
 
     protected function define_structure() {

diff --git a/backup/moodle2/restore_board_activity_task.class.php b/backup/moodle2/restore_board_activity_task.class.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->dirroot . '/mod/board/backup/moodle2/restore_board_stepslib.php'); // Because it exists (must).

diff --git a/backup/moodle2/restore_board_stepslib.php b/backup/moodle2/restore_board_stepslib.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 class restore_board_activity_structure_step extends restore_activity_structure_step {
 
     protected function define_structure() {

diff --git a/classes/board.php b/classes/board.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Jay Churchward <jay@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board;
 
 defined('MOODLE_INTERNAL') || die;

diff --git a/classes/event/add_column.php b/classes/event/add_column.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/add_note.php b/classes/event/add_note.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/delete_column.php b/classes/event/delete_column.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/delete_note.php b/classes/event/delete_note.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/move_note.php b/classes/event/move_note.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/rate_note.php b/classes/event/rate_note.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/update_column.php b/classes/event/update_column.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/classes/event/update_note.php b/classes/event/update_note.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace mod_board\event;
 defined('MOODLE_INTERNAL') || die();
 

diff --git a/db/access.php b/db/access.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die();
 
 $capabilities = array(

diff --git a/db/services.php b/db/services.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 $functions = [

diff --git a/db/upgrade.php b/db/upgrade.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die();
 
 function xmldb_board_upgrade($oldversion) {

diff --git a/download_board.php b/download_board.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require('../../config.php');
 
 use mod_board\board;

diff --git a/download_submissions.php b/download_submissions.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require('../../config.php');
 
 use mod_board\board;

diff --git a/external.php b/external.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die();
 
 require_once("$CFG->libdir/externallib.php");

diff --git a/index.php b/index.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require('../../config.php');
 
 $id = required_param('id', PARAM_INT); // Course id.

diff --git a/lang/en/board.php b/lang/en/board.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 $string['pluginname'] = 'Board';

diff --git a/lib.php b/lib.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 use mod_board\board;

diff --git a/mod_form.php b/mod_form.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 require_once($CFG->dirroot.'/course/moodleform_mod.php');

diff --git a/settings.php b/settings.php
@@ -14,6 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 if ($ADMIN->fulltree) {

diff --git a/version.php b/version.php
@@ -14,8 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * @package     mod_board
+ * @author      Karen Holland <karen@brickfieldlabs.ie>
+ * @copyright   2021 Brickfield Education Labs <https://www.brickfield.ie/>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 $plugin->component = 'mod_board'; // Full name of the plugin (used for diagnostics).
-$plugin->version   = 2021051201; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017110800; // Requires this Moodle version.
+$plugin->version   = 2021052400; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2020061500; // Moodle 3.9 and up.
+$plugin->release = '1.39.01 (Build 2021070500)';
+$plugin->maturity  = MATURITY_STABLE;